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 uart_port_lock_irqsave(__uport, &flags); \
86 #define uart_port_unlock(uport, flags) \
88 struct uart_port *__uport = uport; \
90 uart_port_unlock_irqrestore(__uport, 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);
149 if (err < 0 && err != -EINPROGRESS) {
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 uart_port_lock_irqsave(port, &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 uart_port_unlock_irqrestore(port, 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 uart_port_lock_irq(uport);
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 uart_port_unlock_irq(uport);
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. If that is also invalid 0 is returned.
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,
520 EXPORT_SYMBOL(uart_get_baud_rate);
523 * uart_get_divisor - return uart clock divisor
524 * @port: uart_port structure describing the port
525 * @baud: desired baud rate
527 * Calculate the divisor (baud_base / baud) for the specified @baud,
528 * appropriately rounded.
530 * If 38400 baud and custom divisor is selected, return the custom divisor
533 * Locking: caller dependent
536 uart_get_divisor(struct uart_port *port, unsigned int baud)
541 * Old custom speed handling.
543 if (baud == 38400 && (port->flags & UPF_SPD_MASK) == UPF_SPD_CUST)
544 quot = port->custom_divisor;
546 quot = DIV_ROUND_CLOSEST(port->uartclk, 16 * baud);
550 EXPORT_SYMBOL(uart_get_divisor);
552 static int uart_put_char(struct tty_struct *tty, u8 c)
554 struct uart_state *state = tty->driver_data;
555 struct uart_port *port;
556 struct circ_buf *circ;
561 port = uart_port_lock(state, flags);
563 uart_port_unlock(port, flags);
567 if (port && uart_circ_chars_free(circ) != 0) {
568 circ->buf[circ->head] = c;
569 circ->head = (circ->head + 1) & (UART_XMIT_SIZE - 1);
572 uart_port_unlock(port, flags);
576 static void uart_flush_chars(struct tty_struct *tty)
581 static ssize_t uart_write(struct tty_struct *tty, const u8 *buf, size_t count)
583 struct uart_state *state = tty->driver_data;
584 struct uart_port *port;
585 struct circ_buf *circ;
590 * This means you called this function _after_ the port was
591 * closed. No cookie for you.
596 port = uart_port_lock(state, flags);
599 uart_port_unlock(port, flags);
604 c = CIRC_SPACE_TO_END(circ->head, circ->tail, UART_XMIT_SIZE);
609 memcpy(circ->buf + circ->head, buf, c);
610 circ->head = (circ->head + c) & (UART_XMIT_SIZE - 1);
617 uart_port_unlock(port, flags);
621 static unsigned int uart_write_room(struct tty_struct *tty)
623 struct uart_state *state = tty->driver_data;
624 struct uart_port *port;
628 port = uart_port_lock(state, flags);
629 ret = uart_circ_chars_free(&state->xmit);
630 uart_port_unlock(port, flags);
634 static unsigned int uart_chars_in_buffer(struct tty_struct *tty)
636 struct uart_state *state = tty->driver_data;
637 struct uart_port *port;
641 port = uart_port_lock(state, flags);
642 ret = uart_circ_chars_pending(&state->xmit);
643 uart_port_unlock(port, flags);
647 static void uart_flush_buffer(struct tty_struct *tty)
649 struct uart_state *state = tty->driver_data;
650 struct uart_port *port;
654 * This means you called this function _after_ the port was
655 * closed. No cookie for you.
660 pr_debug("uart_flush_buffer(%d) called\n", tty->index);
662 port = uart_port_lock(state, flags);
665 uart_circ_clear(&state->xmit);
666 if (port->ops->flush_buffer)
667 port->ops->flush_buffer(port);
668 uart_port_unlock(port, flags);
669 tty_port_tty_wakeup(&state->port);
673 * This function performs low-level write of high-priority XON/XOFF
674 * character and accounting for it.
676 * Requires uart_port to implement .serial_out().
678 void uart_xchar_out(struct uart_port *uport, int offset)
680 serial_port_out(uport, offset, uport->x_char);
684 EXPORT_SYMBOL_GPL(uart_xchar_out);
687 * This function is used to send a high-priority XON/XOFF character to
690 static void uart_send_xchar(struct tty_struct *tty, char ch)
692 struct uart_state *state = tty->driver_data;
693 struct uart_port *port;
696 port = uart_port_ref(state);
700 if (port->ops->send_xchar)
701 port->ops->send_xchar(port, ch);
703 uart_port_lock_irqsave(port, &flags);
706 port->ops->start_tx(port);
707 uart_port_unlock_irqrestore(port, flags);
709 uart_port_deref(port);
712 static void uart_throttle(struct tty_struct *tty)
714 struct uart_state *state = tty->driver_data;
715 upstat_t mask = UPSTAT_SYNC_FIFO;
716 struct uart_port *port;
718 port = uart_port_ref(state);
723 mask |= UPSTAT_AUTOXOFF;
725 mask |= UPSTAT_AUTORTS;
727 if (port->status & mask) {
728 port->ops->throttle(port);
729 mask &= ~port->status;
732 if (mask & UPSTAT_AUTORTS)
733 uart_clear_mctrl(port, TIOCM_RTS);
735 if (mask & UPSTAT_AUTOXOFF)
736 uart_send_xchar(tty, STOP_CHAR(tty));
738 uart_port_deref(port);
741 static void uart_unthrottle(struct tty_struct *tty)
743 struct uart_state *state = tty->driver_data;
744 upstat_t mask = UPSTAT_SYNC_FIFO;
745 struct uart_port *port;
747 port = uart_port_ref(state);
752 mask |= UPSTAT_AUTOXOFF;
754 mask |= UPSTAT_AUTORTS;
756 if (port->status & mask) {
757 port->ops->unthrottle(port);
758 mask &= ~port->status;
761 if (mask & UPSTAT_AUTORTS)
762 uart_set_mctrl(port, TIOCM_RTS);
764 if (mask & UPSTAT_AUTOXOFF)
765 uart_send_xchar(tty, START_CHAR(tty));
767 uart_port_deref(port);
770 static int uart_get_info(struct tty_port *port, struct serial_struct *retinfo)
772 struct uart_state *state = container_of(port, struct uart_state, port);
773 struct uart_port *uport;
776 /* Initialize structure in case we error out later to prevent any stack info leakage. */
777 *retinfo = (struct serial_struct){};
780 * Ensure the state we copy is consistent and no hardware changes
783 mutex_lock(&port->mutex);
784 uport = uart_port_check(state);
788 retinfo->type = uport->type;
789 retinfo->line = uport->line;
790 retinfo->port = uport->iobase;
791 if (HIGH_BITS_OFFSET)
792 retinfo->port_high = (long) uport->iobase >> HIGH_BITS_OFFSET;
793 retinfo->irq = uport->irq;
794 retinfo->flags = (__force int)uport->flags;
795 retinfo->xmit_fifo_size = uport->fifosize;
796 retinfo->baud_base = uport->uartclk / 16;
797 retinfo->close_delay = jiffies_to_msecs(port->close_delay) / 10;
798 retinfo->closing_wait = port->closing_wait == ASYNC_CLOSING_WAIT_NONE ?
799 ASYNC_CLOSING_WAIT_NONE :
800 jiffies_to_msecs(port->closing_wait) / 10;
801 retinfo->custom_divisor = uport->custom_divisor;
802 retinfo->hub6 = uport->hub6;
803 retinfo->io_type = uport->iotype;
804 retinfo->iomem_reg_shift = uport->regshift;
805 retinfo->iomem_base = (void *)(unsigned long)uport->mapbase;
809 mutex_unlock(&port->mutex);
813 static int uart_get_info_user(struct tty_struct *tty,
814 struct serial_struct *ss)
816 struct uart_state *state = tty->driver_data;
817 struct tty_port *port = &state->port;
819 return uart_get_info(port, ss) < 0 ? -EIO : 0;
822 static int uart_set_info(struct tty_struct *tty, struct tty_port *port,
823 struct uart_state *state,
824 struct serial_struct *new_info)
826 struct uart_port *uport = uart_port_check(state);
827 unsigned long new_port;
828 unsigned int change_irq, change_port, closing_wait;
829 unsigned int old_custom_divisor, close_delay;
830 upf_t old_flags, new_flags;
836 new_port = new_info->port;
837 if (HIGH_BITS_OFFSET)
838 new_port += (unsigned long) new_info->port_high << HIGH_BITS_OFFSET;
840 new_info->irq = irq_canonicalize(new_info->irq);
841 close_delay = msecs_to_jiffies(new_info->close_delay * 10);
842 closing_wait = new_info->closing_wait == ASYNC_CLOSING_WAIT_NONE ?
843 ASYNC_CLOSING_WAIT_NONE :
844 msecs_to_jiffies(new_info->closing_wait * 10);
847 change_irq = !(uport->flags & UPF_FIXED_PORT)
848 && new_info->irq != uport->irq;
851 * Since changing the 'type' of the port changes its resource
852 * allocations, we should treat type changes the same as
855 change_port = !(uport->flags & UPF_FIXED_PORT)
856 && (new_port != uport->iobase ||
857 (unsigned long)new_info->iomem_base != uport->mapbase ||
858 new_info->hub6 != uport->hub6 ||
859 new_info->io_type != uport->iotype ||
860 new_info->iomem_reg_shift != uport->regshift ||
861 new_info->type != uport->type);
863 old_flags = uport->flags;
864 new_flags = (__force upf_t)new_info->flags;
865 old_custom_divisor = uport->custom_divisor;
867 if (!capable(CAP_SYS_ADMIN)) {
869 if (change_irq || change_port ||
870 (new_info->baud_base != uport->uartclk / 16) ||
871 (close_delay != port->close_delay) ||
872 (closing_wait != port->closing_wait) ||
873 (new_info->xmit_fifo_size &&
874 new_info->xmit_fifo_size != uport->fifosize) ||
875 (((new_flags ^ old_flags) & ~UPF_USR_MASK) != 0))
877 uport->flags = ((uport->flags & ~UPF_USR_MASK) |
878 (new_flags & UPF_USR_MASK));
879 uport->custom_divisor = new_info->custom_divisor;
883 if (change_irq || change_port) {
884 retval = security_locked_down(LOCKDOWN_TIOCSSERIAL);
890 * Ask the low level driver to verify the settings.
892 if (uport->ops->verify_port)
893 retval = uport->ops->verify_port(uport, new_info);
895 if ((new_info->irq >= nr_irqs) || (new_info->irq < 0) ||
896 (new_info->baud_base < 9600))
902 if (change_port || change_irq) {
906 * Make sure that we are the sole user of this port.
908 if (tty_port_users(port) > 1)
912 * We need to shutdown the serial port at the old
913 * port/type/irq combination.
915 uart_shutdown(tty, state);
919 unsigned long old_iobase, old_mapbase;
920 unsigned int old_type, old_iotype, old_hub6, old_shift;
922 old_iobase = uport->iobase;
923 old_mapbase = uport->mapbase;
924 old_type = uport->type;
925 old_hub6 = uport->hub6;
926 old_iotype = uport->iotype;
927 old_shift = uport->regshift;
930 * Free and release old regions
932 if (old_type != PORT_UNKNOWN && uport->ops->release_port)
933 uport->ops->release_port(uport);
935 uport->iobase = new_port;
936 uport->type = new_info->type;
937 uport->hub6 = new_info->hub6;
938 uport->iotype = new_info->io_type;
939 uport->regshift = new_info->iomem_reg_shift;
940 uport->mapbase = (unsigned long)new_info->iomem_base;
943 * Claim and map the new regions
945 if (uport->type != PORT_UNKNOWN && uport->ops->request_port) {
946 retval = uport->ops->request_port(uport);
948 /* Always success - Jean II */
953 * If we fail to request resources for the
954 * new port, try to restore the old settings.
957 uport->iobase = old_iobase;
958 uport->type = old_type;
959 uport->hub6 = old_hub6;
960 uport->iotype = old_iotype;
961 uport->regshift = old_shift;
962 uport->mapbase = old_mapbase;
964 if (old_type != PORT_UNKNOWN) {
965 retval = uport->ops->request_port(uport);
967 * If we failed to restore the old settings,
971 uport->type = PORT_UNKNOWN;
979 /* Added to return the correct error -Ram Gupta */
985 uport->irq = new_info->irq;
986 if (!(uport->flags & UPF_FIXED_PORT))
987 uport->uartclk = new_info->baud_base * 16;
988 uport->flags = (uport->flags & ~UPF_CHANGE_MASK) |
989 (new_flags & UPF_CHANGE_MASK);
990 uport->custom_divisor = new_info->custom_divisor;
991 port->close_delay = close_delay;
992 port->closing_wait = closing_wait;
993 if (new_info->xmit_fifo_size)
994 uport->fifosize = new_info->xmit_fifo_size;
998 if (uport->type == PORT_UNKNOWN)
1000 if (tty_port_initialized(port)) {
1001 if (((old_flags ^ uport->flags) & UPF_SPD_MASK) ||
1002 old_custom_divisor != uport->custom_divisor) {
1004 * If they're setting up a custom divisor or speed,
1005 * instead of clearing it, then bitch about it.
1007 if (uport->flags & UPF_SPD_MASK) {
1008 dev_notice_ratelimited(uport->dev,
1009 "%s sets custom speed on %s. This is deprecated.\n",
1011 tty_name(port->tty));
1013 uart_change_line_settings(tty, state, NULL);
1016 retval = uart_startup(tty, state, true);
1018 tty_port_set_initialized(port, true);
1026 static int uart_set_info_user(struct tty_struct *tty, struct serial_struct *ss)
1028 struct uart_state *state = tty->driver_data;
1029 struct tty_port *port = &state->port;
1032 down_write(&tty->termios_rwsem);
1034 * This semaphore protects port->count. It is also
1035 * very useful to prevent opens. Also, take the
1036 * port configuration semaphore to make sure that a
1037 * module insertion/removal doesn't change anything
1040 mutex_lock(&port->mutex);
1041 retval = uart_set_info(tty, port, state, ss);
1042 mutex_unlock(&port->mutex);
1043 up_write(&tty->termios_rwsem);
1048 * uart_get_lsr_info - get line status register info
1049 * @tty: tty associated with the UART
1050 * @state: UART being queried
1051 * @value: returned modem value
1053 static int uart_get_lsr_info(struct tty_struct *tty,
1054 struct uart_state *state, unsigned int __user *value)
1056 struct uart_port *uport = uart_port_check(state);
1057 unsigned int result;
1059 result = uport->ops->tx_empty(uport);
1062 * If we're about to load something into the transmit
1063 * register, we'll pretend the transmitter isn't empty to
1064 * avoid a race condition (depending on when the transmit
1065 * interrupt happens).
1067 if (uport->x_char ||
1068 ((uart_circ_chars_pending(&state->xmit) > 0) &&
1069 !uart_tx_stopped(uport)))
1070 result &= ~TIOCSER_TEMT;
1072 return put_user(result, value);
1075 static int uart_tiocmget(struct tty_struct *tty)
1077 struct uart_state *state = tty->driver_data;
1078 struct tty_port *port = &state->port;
1079 struct uart_port *uport;
1082 mutex_lock(&port->mutex);
1083 uport = uart_port_check(state);
1087 if (!tty_io_error(tty)) {
1088 uart_port_lock_irq(uport);
1089 result = uport->mctrl;
1090 result |= uport->ops->get_mctrl(uport);
1091 uart_port_unlock_irq(uport);
1094 mutex_unlock(&port->mutex);
1099 uart_tiocmset(struct tty_struct *tty, unsigned int set, unsigned int clear)
1101 struct uart_state *state = tty->driver_data;
1102 struct tty_port *port = &state->port;
1103 struct uart_port *uport;
1106 mutex_lock(&port->mutex);
1107 uport = uart_port_check(state);
1111 if (!tty_io_error(tty)) {
1112 uart_update_mctrl(uport, set, clear);
1116 mutex_unlock(&port->mutex);
1120 static int uart_break_ctl(struct tty_struct *tty, int break_state)
1122 struct uart_state *state = tty->driver_data;
1123 struct tty_port *port = &state->port;
1124 struct uart_port *uport;
1127 mutex_lock(&port->mutex);
1128 uport = uart_port_check(state);
1132 if (uport->type != PORT_UNKNOWN && uport->ops->break_ctl)
1133 uport->ops->break_ctl(uport, break_state);
1136 mutex_unlock(&port->mutex);
1140 static int uart_do_autoconfig(struct tty_struct *tty, struct uart_state *state)
1142 struct tty_port *port = &state->port;
1143 struct uart_port *uport;
1146 if (!capable(CAP_SYS_ADMIN))
1150 * Take the per-port semaphore. This prevents count from
1151 * changing, and hence any extra opens of the port while
1152 * we're auto-configuring.
1154 if (mutex_lock_interruptible(&port->mutex))
1155 return -ERESTARTSYS;
1157 uport = uart_port_check(state);
1164 if (tty_port_users(port) == 1) {
1165 uart_shutdown(tty, state);
1168 * If we already have a port type configured,
1169 * we must release its resources.
1171 if (uport->type != PORT_UNKNOWN && uport->ops->release_port)
1172 uport->ops->release_port(uport);
1174 flags = UART_CONFIG_TYPE;
1175 if (uport->flags & UPF_AUTO_IRQ)
1176 flags |= UART_CONFIG_IRQ;
1179 * This will claim the ports resources if
1182 uport->ops->config_port(uport, flags);
1184 ret = uart_startup(tty, state, true);
1186 tty_port_set_initialized(port, true);
1191 mutex_unlock(&port->mutex);
1195 static void uart_enable_ms(struct uart_port *uport)
1198 * Force modem status interrupts on
1200 if (uport->ops->enable_ms)
1201 uport->ops->enable_ms(uport);
1205 * Wait for any of the 4 modem inputs (DCD,RI,DSR,CTS) to change
1206 * - mask passed in arg for lines of interest
1207 * (use |'ed TIOCM_RNG/DSR/CD/CTS for masking)
1208 * Caller should use TIOCGICOUNT to see which one it was
1210 * FIXME: This wants extracting into a common all driver implementation
1211 * of TIOCMWAIT using tty_port.
1213 static int uart_wait_modem_status(struct uart_state *state, unsigned long arg)
1215 struct uart_port *uport;
1216 struct tty_port *port = &state->port;
1217 DECLARE_WAITQUEUE(wait, current);
1218 struct uart_icount cprev, cnow;
1222 * note the counters on entry
1224 uport = uart_port_ref(state);
1227 uart_port_lock_irq(uport);
1228 memcpy(&cprev, &uport->icount, sizeof(struct uart_icount));
1229 uart_enable_ms(uport);
1230 uart_port_unlock_irq(uport);
1232 add_wait_queue(&port->delta_msr_wait, &wait);
1234 uart_port_lock_irq(uport);
1235 memcpy(&cnow, &uport->icount, sizeof(struct uart_icount));
1236 uart_port_unlock_irq(uport);
1238 set_current_state(TASK_INTERRUPTIBLE);
1240 if (((arg & TIOCM_RNG) && (cnow.rng != cprev.rng)) ||
1241 ((arg & TIOCM_DSR) && (cnow.dsr != cprev.dsr)) ||
1242 ((arg & TIOCM_CD) && (cnow.dcd != cprev.dcd)) ||
1243 ((arg & TIOCM_CTS) && (cnow.cts != cprev.cts))) {
1250 /* see if a signal did it */
1251 if (signal_pending(current)) {
1258 __set_current_state(TASK_RUNNING);
1259 remove_wait_queue(&port->delta_msr_wait, &wait);
1260 uart_port_deref(uport);
1266 * Get counter of input serial line interrupts (DCD,RI,DSR,CTS)
1267 * Return: write counters to the user passed counter struct
1268 * NB: both 1->0 and 0->1 transitions are counted except for
1269 * RI where only 0->1 is counted.
1271 static int uart_get_icount(struct tty_struct *tty,
1272 struct serial_icounter_struct *icount)
1274 struct uart_state *state = tty->driver_data;
1275 struct uart_icount cnow;
1276 struct uart_port *uport;
1278 uport = uart_port_ref(state);
1281 uart_port_lock_irq(uport);
1282 memcpy(&cnow, &uport->icount, sizeof(struct uart_icount));
1283 uart_port_unlock_irq(uport);
1284 uart_port_deref(uport);
1286 icount->cts = cnow.cts;
1287 icount->dsr = cnow.dsr;
1288 icount->rng = cnow.rng;
1289 icount->dcd = cnow.dcd;
1290 icount->rx = cnow.rx;
1291 icount->tx = cnow.tx;
1292 icount->frame = cnow.frame;
1293 icount->overrun = cnow.overrun;
1294 icount->parity = cnow.parity;
1295 icount->brk = cnow.brk;
1296 icount->buf_overrun = cnow.buf_overrun;
1301 #define SER_RS485_LEGACY_FLAGS (SER_RS485_ENABLED | SER_RS485_RTS_ON_SEND | \
1302 SER_RS485_RTS_AFTER_SEND | SER_RS485_RX_DURING_TX | \
1303 SER_RS485_TERMINATE_BUS)
1305 static int uart_check_rs485_flags(struct uart_port *port, struct serial_rs485 *rs485)
1307 u32 flags = rs485->flags;
1309 /* Don't return -EINVAL for unsupported legacy flags */
1310 flags &= ~SER_RS485_LEGACY_FLAGS;
1313 * For any bit outside of the legacy ones that is not supported by
1314 * the driver, return -EINVAL.
1316 if (flags & ~port->rs485_supported.flags)
1319 /* Asking for address w/o addressing mode? */
1320 if (!(rs485->flags & SER_RS485_ADDRB) &&
1321 (rs485->flags & (SER_RS485_ADDR_RECV|SER_RS485_ADDR_DEST)))
1324 /* Address given but not enabled? */
1325 if (!(rs485->flags & SER_RS485_ADDR_RECV) && rs485->addr_recv)
1327 if (!(rs485->flags & SER_RS485_ADDR_DEST) && rs485->addr_dest)
1333 static void uart_sanitize_serial_rs485_delays(struct uart_port *port,
1334 struct serial_rs485 *rs485)
1336 if (!port->rs485_supported.delay_rts_before_send) {
1337 if (rs485->delay_rts_before_send) {
1338 dev_warn_ratelimited(port->dev,
1339 "%s (%d): RTS delay before sending not supported\n",
1340 port->name, port->line);
1342 rs485->delay_rts_before_send = 0;
1343 } else if (rs485->delay_rts_before_send > RS485_MAX_RTS_DELAY) {
1344 rs485->delay_rts_before_send = RS485_MAX_RTS_DELAY;
1345 dev_warn_ratelimited(port->dev,
1346 "%s (%d): RTS delay before sending clamped to %u ms\n",
1347 port->name, port->line, rs485->delay_rts_before_send);
1350 if (!port->rs485_supported.delay_rts_after_send) {
1351 if (rs485->delay_rts_after_send) {
1352 dev_warn_ratelimited(port->dev,
1353 "%s (%d): RTS delay after sending not supported\n",
1354 port->name, port->line);
1356 rs485->delay_rts_after_send = 0;
1357 } else if (rs485->delay_rts_after_send > RS485_MAX_RTS_DELAY) {
1358 rs485->delay_rts_after_send = RS485_MAX_RTS_DELAY;
1359 dev_warn_ratelimited(port->dev,
1360 "%s (%d): RTS delay after sending clamped to %u ms\n",
1361 port->name, port->line, rs485->delay_rts_after_send);
1365 static void uart_sanitize_serial_rs485(struct uart_port *port, struct serial_rs485 *rs485)
1367 u32 supported_flags = port->rs485_supported.flags;
1369 if (!(rs485->flags & SER_RS485_ENABLED)) {
1370 memset(rs485, 0, sizeof(*rs485));
1374 rs485->flags &= supported_flags;
1376 /* Pick sane settings if the user hasn't */
1377 if (!(rs485->flags & SER_RS485_RTS_ON_SEND) ==
1378 !(rs485->flags & SER_RS485_RTS_AFTER_SEND)) {
1379 if (supported_flags & SER_RS485_RTS_ON_SEND) {
1380 rs485->flags |= SER_RS485_RTS_ON_SEND;
1381 rs485->flags &= ~SER_RS485_RTS_AFTER_SEND;
1383 dev_warn_ratelimited(port->dev,
1384 "%s (%d): invalid RTS setting, using RTS_ON_SEND instead\n",
1385 port->name, port->line);
1387 rs485->flags |= SER_RS485_RTS_AFTER_SEND;
1388 rs485->flags &= ~SER_RS485_RTS_ON_SEND;
1390 dev_warn_ratelimited(port->dev,
1391 "%s (%d): invalid RTS setting, using RTS_AFTER_SEND instead\n",
1392 port->name, port->line);
1396 uart_sanitize_serial_rs485_delays(port, rs485);
1398 /* Return clean padding area to userspace */
1399 memset(rs485->padding0, 0, sizeof(rs485->padding0));
1400 memset(rs485->padding1, 0, sizeof(rs485->padding1));
1403 static void uart_set_rs485_termination(struct uart_port *port,
1404 const struct serial_rs485 *rs485)
1406 if (!(rs485->flags & SER_RS485_ENABLED))
1409 gpiod_set_value_cansleep(port->rs485_term_gpio,
1410 !!(rs485->flags & SER_RS485_TERMINATE_BUS));
1413 static void uart_set_rs485_rx_during_tx(struct uart_port *port,
1414 const struct serial_rs485 *rs485)
1416 if (!(rs485->flags & SER_RS485_ENABLED))
1419 gpiod_set_value_cansleep(port->rs485_rx_during_tx_gpio,
1420 !!(rs485->flags & SER_RS485_RX_DURING_TX));
1423 static int uart_rs485_config(struct uart_port *port)
1425 struct serial_rs485 *rs485 = &port->rs485;
1426 unsigned long flags;
1429 if (!(rs485->flags & SER_RS485_ENABLED))
1432 uart_sanitize_serial_rs485(port, rs485);
1433 uart_set_rs485_termination(port, rs485);
1434 uart_set_rs485_rx_during_tx(port, rs485);
1436 uart_port_lock_irqsave(port, &flags);
1437 ret = port->rs485_config(port, NULL, rs485);
1438 uart_port_unlock_irqrestore(port, flags);
1440 memset(rs485, 0, sizeof(*rs485));
1442 gpiod_set_value_cansleep(port->rs485_term_gpio, 0);
1443 gpiod_set_value_cansleep(port->rs485_rx_during_tx_gpio, 0);
1449 static int uart_get_rs485_config(struct uart_port *port,
1450 struct serial_rs485 __user *rs485)
1452 unsigned long flags;
1453 struct serial_rs485 aux;
1455 uart_port_lock_irqsave(port, &flags);
1457 uart_port_unlock_irqrestore(port, flags);
1459 if (copy_to_user(rs485, &aux, sizeof(aux)))
1465 static int uart_set_rs485_config(struct tty_struct *tty, struct uart_port *port,
1466 struct serial_rs485 __user *rs485_user)
1468 struct serial_rs485 rs485;
1470 unsigned long flags;
1472 if (!(port->rs485_supported.flags & SER_RS485_ENABLED))
1475 if (copy_from_user(&rs485, rs485_user, sizeof(*rs485_user)))
1478 ret = uart_check_rs485_flags(port, &rs485);
1481 uart_sanitize_serial_rs485(port, &rs485);
1482 uart_set_rs485_termination(port, &rs485);
1483 uart_set_rs485_rx_during_tx(port, &rs485);
1485 uart_port_lock_irqsave(port, &flags);
1486 ret = port->rs485_config(port, &tty->termios, &rs485);
1488 port->rs485 = rs485;
1490 /* Reset RTS and other mctrl lines when disabling RS485 */
1491 if (!(rs485.flags & SER_RS485_ENABLED))
1492 port->ops->set_mctrl(port, port->mctrl);
1494 uart_port_unlock_irqrestore(port, flags);
1496 /* restore old GPIO settings */
1497 gpiod_set_value_cansleep(port->rs485_term_gpio,
1498 !!(port->rs485.flags & SER_RS485_TERMINATE_BUS));
1499 gpiod_set_value_cansleep(port->rs485_rx_during_tx_gpio,
1500 !!(port->rs485.flags & SER_RS485_RX_DURING_TX));
1504 if (copy_to_user(rs485_user, &port->rs485, sizeof(port->rs485)))
1510 static int uart_get_iso7816_config(struct uart_port *port,
1511 struct serial_iso7816 __user *iso7816)
1513 unsigned long flags;
1514 struct serial_iso7816 aux;
1516 if (!port->iso7816_config)
1519 uart_port_lock_irqsave(port, &flags);
1520 aux = port->iso7816;
1521 uart_port_unlock_irqrestore(port, flags);
1523 if (copy_to_user(iso7816, &aux, sizeof(aux)))
1529 static int uart_set_iso7816_config(struct uart_port *port,
1530 struct serial_iso7816 __user *iso7816_user)
1532 struct serial_iso7816 iso7816;
1534 unsigned long flags;
1536 if (!port->iso7816_config)
1539 if (copy_from_user(&iso7816, iso7816_user, sizeof(*iso7816_user)))
1543 * There are 5 words reserved for future use. Check that userspace
1544 * doesn't put stuff in there to prevent breakages in the future.
1546 for (i = 0; i < ARRAY_SIZE(iso7816.reserved); i++)
1547 if (iso7816.reserved[i])
1550 uart_port_lock_irqsave(port, &flags);
1551 ret = port->iso7816_config(port, &iso7816);
1552 uart_port_unlock_irqrestore(port, flags);
1556 if (copy_to_user(iso7816_user, &port->iso7816, sizeof(port->iso7816)))
1563 * Called via sys_ioctl. We can use spin_lock_irq() here.
1566 uart_ioctl(struct tty_struct *tty, unsigned int cmd, unsigned long arg)
1568 struct uart_state *state = tty->driver_data;
1569 struct tty_port *port = &state->port;
1570 struct uart_port *uport;
1571 void __user *uarg = (void __user *)arg;
1572 int ret = -ENOIOCTLCMD;
1576 * These ioctls don't rely on the hardware to be present.
1580 down_write(&tty->termios_rwsem);
1581 ret = uart_do_autoconfig(tty, state);
1582 up_write(&tty->termios_rwsem);
1586 if (ret != -ENOIOCTLCMD)
1589 if (tty_io_error(tty)) {
1595 * The following should only be used when hardware is present.
1599 ret = uart_wait_modem_status(state, arg);
1603 if (ret != -ENOIOCTLCMD)
1606 /* rs485_config requires more locking than others */
1607 if (cmd == TIOCSRS485)
1608 down_write(&tty->termios_rwsem);
1610 mutex_lock(&port->mutex);
1611 uport = uart_port_check(state);
1613 if (!uport || tty_io_error(tty)) {
1619 * All these rely on hardware being present and need to be
1620 * protected against the tty being hung up.
1624 case TIOCSERGETLSR: /* Get line status register */
1625 ret = uart_get_lsr_info(tty, state, uarg);
1629 ret = uart_get_rs485_config(uport, uarg);
1633 ret = uart_set_rs485_config(tty, uport, uarg);
1637 ret = uart_set_iso7816_config(state->uart_port, uarg);
1641 ret = uart_get_iso7816_config(state->uart_port, uarg);
1644 if (uport->ops->ioctl)
1645 ret = uport->ops->ioctl(uport, cmd, arg);
1649 mutex_unlock(&port->mutex);
1650 if (cmd == TIOCSRS485)
1651 up_write(&tty->termios_rwsem);
1656 static void uart_set_ldisc(struct tty_struct *tty)
1658 struct uart_state *state = tty->driver_data;
1659 struct uart_port *uport;
1660 struct tty_port *port = &state->port;
1662 if (!tty_port_initialized(port))
1665 mutex_lock(&state->port.mutex);
1666 uport = uart_port_check(state);
1667 if (uport && uport->ops->set_ldisc)
1668 uport->ops->set_ldisc(uport, &tty->termios);
1669 mutex_unlock(&state->port.mutex);
1672 static void uart_set_termios(struct tty_struct *tty,
1673 const struct ktermios *old_termios)
1675 struct uart_state *state = tty->driver_data;
1676 struct uart_port *uport;
1677 unsigned int cflag = tty->termios.c_cflag;
1678 unsigned int iflag_mask = IGNBRK|BRKINT|IGNPAR|PARMRK|INPCK;
1679 bool sw_changed = false;
1681 mutex_lock(&state->port.mutex);
1682 uport = uart_port_check(state);
1687 * Drivers doing software flow control also need to know
1688 * about changes to these input settings.
1690 if (uport->flags & UPF_SOFT_FLOW) {
1691 iflag_mask |= IXANY|IXON|IXOFF;
1693 tty->termios.c_cc[VSTART] != old_termios->c_cc[VSTART] ||
1694 tty->termios.c_cc[VSTOP] != old_termios->c_cc[VSTOP];
1698 * These are the bits that are used to setup various
1699 * flags in the low level driver. We can ignore the Bfoo
1700 * bits in c_cflag; c_[io]speed will always be set
1701 * appropriately by set_termios() in tty_ioctl.c
1703 if ((cflag ^ old_termios->c_cflag) == 0 &&
1704 tty->termios.c_ospeed == old_termios->c_ospeed &&
1705 tty->termios.c_ispeed == old_termios->c_ispeed &&
1706 ((tty->termios.c_iflag ^ old_termios->c_iflag) & iflag_mask) == 0 &&
1711 uart_change_line_settings(tty, state, old_termios);
1712 /* reload cflag from termios; port driver may have overridden flags */
1713 cflag = tty->termios.c_cflag;
1715 /* Handle transition to B0 status */
1716 if (((old_termios->c_cflag & CBAUD) != B0) && ((cflag & CBAUD) == B0))
1717 uart_clear_mctrl(uport, TIOCM_RTS | TIOCM_DTR);
1718 /* Handle transition away from B0 status */
1719 else if (((old_termios->c_cflag & CBAUD) == B0) && ((cflag & CBAUD) != B0)) {
1720 unsigned int mask = TIOCM_DTR;
1722 if (!(cflag & CRTSCTS) || !tty_throttled(tty))
1724 uart_set_mctrl(uport, mask);
1727 mutex_unlock(&state->port.mutex);
1731 * Calls to uart_close() are serialised via the tty_lock in
1732 * drivers/tty/tty_io.c:tty_release()
1733 * drivers/tty/tty_io.c:do_tty_hangup()
1735 static void uart_close(struct tty_struct *tty, struct file *filp)
1737 struct uart_state *state = tty->driver_data;
1740 struct uart_driver *drv = tty->driver->driver_state;
1741 struct tty_port *port;
1743 state = drv->state + tty->index;
1744 port = &state->port;
1745 spin_lock_irq(&port->lock);
1747 spin_unlock_irq(&port->lock);
1751 pr_debug("uart_close(%d) called\n", tty->index);
1753 tty_port_close(tty->port, tty, filp);
1756 static void uart_tty_port_shutdown(struct tty_port *port)
1758 struct uart_state *state = container_of(port, struct uart_state, port);
1759 struct uart_port *uport = uart_port_check(state);
1763 * At this point, we stop accepting input. To do this, we
1764 * disable the receive line status interrupts.
1766 if (WARN(!uport, "detached port still initialized!\n"))
1769 uart_port_lock_irq(uport);
1770 uport->ops->stop_rx(uport);
1771 uart_port_unlock_irq(uport);
1773 uart_port_shutdown(port);
1776 * It's possible for shutdown to be called after suspend if we get
1777 * a DCD drop (hangup) at just the right time. Clear suspended bit so
1778 * we don't try to resume a port that has been shutdown.
1780 tty_port_set_suspended(port, false);
1783 * Free the transmit buffer.
1785 uart_port_lock_irq(uport);
1786 buf = state->xmit.buf;
1787 state->xmit.buf = NULL;
1788 uart_port_unlock_irq(uport);
1790 free_page((unsigned long)buf);
1792 uart_change_pm(state, UART_PM_STATE_OFF);
1795 static void uart_wait_until_sent(struct tty_struct *tty, int timeout)
1797 struct uart_state *state = tty->driver_data;
1798 struct uart_port *port;
1799 unsigned long char_time, expire, fifo_timeout;
1801 port = uart_port_ref(state);
1805 if (port->type == PORT_UNKNOWN || port->fifosize == 0) {
1806 uart_port_deref(port);
1811 * Set the check interval to be 1/5 of the estimated time to
1812 * send a single character, and make it at least 1. The check
1813 * interval should also be less than the timeout.
1815 * Note: we have to use pretty tight timings here to satisfy
1818 char_time = max(nsecs_to_jiffies(port->frame_time / 5), 1UL);
1820 if (timeout && timeout < char_time)
1821 char_time = timeout;
1823 if (!uart_cts_enabled(port)) {
1825 * If the transmitter hasn't cleared in twice the approximate
1826 * amount of time to send the entire FIFO, it probably won't
1827 * ever clear. This assumes the UART isn't doing flow
1828 * control, which is currently the case. Hence, if it ever
1829 * takes longer than FIFO timeout, this is probably due to a
1830 * UART bug of some kind. So, we clamp the timeout parameter at
1833 fifo_timeout = uart_fifo_timeout(port);
1834 if (timeout == 0 || timeout > 2 * fifo_timeout)
1835 timeout = 2 * fifo_timeout;
1838 expire = jiffies + timeout;
1840 pr_debug("uart_wait_until_sent(%d), jiffies=%lu, expire=%lu...\n",
1841 port->line, jiffies, expire);
1844 * Check whether the transmitter is empty every 'char_time'.
1845 * 'timeout' / 'expire' give us the maximum amount of time
1848 while (!port->ops->tx_empty(port)) {
1849 msleep_interruptible(jiffies_to_msecs(char_time));
1850 if (signal_pending(current))
1852 if (timeout && time_after(jiffies, expire))
1855 uart_port_deref(port);
1859 * Calls to uart_hangup() are serialised by the tty_lock in
1860 * drivers/tty/tty_io.c:do_tty_hangup()
1861 * This runs from a workqueue and can sleep for a _short_ time only.
1863 static void uart_hangup(struct tty_struct *tty)
1865 struct uart_state *state = tty->driver_data;
1866 struct tty_port *port = &state->port;
1867 struct uart_port *uport;
1868 unsigned long flags;
1870 pr_debug("uart_hangup(%d)\n", tty->index);
1872 mutex_lock(&port->mutex);
1873 uport = uart_port_check(state);
1874 WARN(!uport, "hangup of detached port!\n");
1876 if (tty_port_active(port)) {
1877 uart_flush_buffer(tty);
1878 uart_shutdown(tty, state);
1879 spin_lock_irqsave(&port->lock, flags);
1881 spin_unlock_irqrestore(&port->lock, flags);
1882 tty_port_set_active(port, false);
1883 tty_port_tty_set(port, NULL);
1884 if (uport && !uart_console(uport))
1885 uart_change_pm(state, UART_PM_STATE_OFF);
1886 wake_up_interruptible(&port->open_wait);
1887 wake_up_interruptible(&port->delta_msr_wait);
1889 mutex_unlock(&port->mutex);
1892 /* uport == NULL if uart_port has already been removed */
1893 static void uart_port_shutdown(struct tty_port *port)
1895 struct uart_state *state = container_of(port, struct uart_state, port);
1896 struct uart_port *uport = uart_port_check(state);
1899 * clear delta_msr_wait queue to avoid mem leaks: we may free
1900 * the irq here so the queue might never be woken up. Note
1901 * that we won't end up waiting on delta_msr_wait again since
1902 * any outstanding file descriptors should be pointing at
1903 * hung_up_tty_fops now.
1905 wake_up_interruptible(&port->delta_msr_wait);
1908 /* Free the IRQ and disable the port. */
1909 uport->ops->shutdown(uport);
1911 /* Ensure that the IRQ handler isn't running on another CPU. */
1912 synchronize_irq(uport->irq);
1916 static bool uart_carrier_raised(struct tty_port *port)
1918 struct uart_state *state = container_of(port, struct uart_state, port);
1919 struct uart_port *uport;
1922 uport = uart_port_ref(state);
1924 * Should never observe uport == NULL since checks for hangup should
1925 * abort the tty_port_block_til_ready() loop before checking for carrier
1926 * raised -- but report carrier raised if it does anyway so open will
1927 * continue and not sleep
1929 if (WARN_ON(!uport))
1931 uart_port_lock_irq(uport);
1932 uart_enable_ms(uport);
1933 mctrl = uport->ops->get_mctrl(uport);
1934 uart_port_unlock_irq(uport);
1935 uart_port_deref(uport);
1937 return mctrl & TIOCM_CAR;
1940 static void uart_dtr_rts(struct tty_port *port, bool active)
1942 struct uart_state *state = container_of(port, struct uart_state, port);
1943 struct uart_port *uport;
1945 uport = uart_port_ref(state);
1948 uart_port_dtr_rts(uport, active);
1949 uart_port_deref(uport);
1952 static int uart_install(struct tty_driver *driver, struct tty_struct *tty)
1954 struct uart_driver *drv = driver->driver_state;
1955 struct uart_state *state = drv->state + tty->index;
1957 tty->driver_data = state;
1959 return tty_standard_install(driver, tty);
1963 * Calls to uart_open are serialised by the tty_lock in
1964 * drivers/tty/tty_io.c:tty_open()
1965 * Note that if this fails, then uart_close() _will_ be called.
1967 * In time, we want to scrap the "opening nonpresent ports"
1968 * behaviour and implement an alternative way for setserial
1969 * to set base addresses/ports/types. This will allow us to
1970 * get rid of a certain amount of extra tests.
1972 static int uart_open(struct tty_struct *tty, struct file *filp)
1974 struct uart_state *state = tty->driver_data;
1977 retval = tty_port_open(&state->port, tty, filp);
1984 static int uart_port_activate(struct tty_port *port, struct tty_struct *tty)
1986 struct uart_state *state = container_of(port, struct uart_state, port);
1987 struct uart_port *uport;
1990 uport = uart_port_check(state);
1991 if (!uport || uport->flags & UPF_DEAD)
1995 * Start up the serial port.
1997 ret = uart_startup(tty, state, false);
1999 tty_port_set_active(port, true);
2004 static const char *uart_type(struct uart_port *port)
2006 const char *str = NULL;
2008 if (port->ops->type)
2009 str = port->ops->type(port);
2017 #ifdef CONFIG_PROC_FS
2019 static void uart_line_info(struct seq_file *m, struct uart_driver *drv, int i)
2021 struct uart_state *state = drv->state + i;
2022 struct tty_port *port = &state->port;
2023 enum uart_pm_state pm_state;
2024 struct uart_port *uport;
2026 unsigned int status;
2029 mutex_lock(&port->mutex);
2030 uport = uart_port_check(state);
2034 mmio = uport->iotype >= UPIO_MEM;
2035 seq_printf(m, "%d: uart:%s %s%08llX irq:%d",
2036 uport->line, uart_type(uport),
2037 mmio ? "mmio:0x" : "port:",
2038 mmio ? (unsigned long long)uport->mapbase
2039 : (unsigned long long)uport->iobase,
2042 if (uport->type == PORT_UNKNOWN) {
2047 if (capable(CAP_SYS_ADMIN)) {
2048 pm_state = state->pm_state;
2049 if (pm_state != UART_PM_STATE_ON)
2050 uart_change_pm(state, UART_PM_STATE_ON);
2051 uart_port_lock_irq(uport);
2052 status = uport->ops->get_mctrl(uport);
2053 uart_port_unlock_irq(uport);
2054 if (pm_state != UART_PM_STATE_ON)
2055 uart_change_pm(state, pm_state);
2057 seq_printf(m, " tx:%d rx:%d",
2058 uport->icount.tx, uport->icount.rx);
2059 if (uport->icount.frame)
2060 seq_printf(m, " fe:%d", uport->icount.frame);
2061 if (uport->icount.parity)
2062 seq_printf(m, " pe:%d", uport->icount.parity);
2063 if (uport->icount.brk)
2064 seq_printf(m, " brk:%d", uport->icount.brk);
2065 if (uport->icount.overrun)
2066 seq_printf(m, " oe:%d", uport->icount.overrun);
2067 if (uport->icount.buf_overrun)
2068 seq_printf(m, " bo:%d", uport->icount.buf_overrun);
2070 #define INFOBIT(bit, str) \
2071 if (uport->mctrl & (bit)) \
2072 strncat(stat_buf, (str), sizeof(stat_buf) - \
2073 strlen(stat_buf) - 2)
2074 #define STATBIT(bit, str) \
2075 if (status & (bit)) \
2076 strncat(stat_buf, (str), sizeof(stat_buf) - \
2077 strlen(stat_buf) - 2)
2081 INFOBIT(TIOCM_RTS, "|RTS");
2082 STATBIT(TIOCM_CTS, "|CTS");
2083 INFOBIT(TIOCM_DTR, "|DTR");
2084 STATBIT(TIOCM_DSR, "|DSR");
2085 STATBIT(TIOCM_CAR, "|CD");
2086 STATBIT(TIOCM_RNG, "|RI");
2090 seq_puts(m, stat_buf);
2096 mutex_unlock(&port->mutex);
2099 static int uart_proc_show(struct seq_file *m, void *v)
2101 struct tty_driver *ttydrv = m->private;
2102 struct uart_driver *drv = ttydrv->driver_state;
2105 seq_printf(m, "serinfo:1.0 driver%s%s revision:%s\n", "", "", "");
2106 for (i = 0; i < drv->nr; i++)
2107 uart_line_info(m, drv, i);
2112 static void uart_port_spin_lock_init(struct uart_port *port)
2114 spin_lock_init(&port->lock);
2115 lockdep_set_class(&port->lock, &port_lock_key);
2118 #if defined(CONFIG_SERIAL_CORE_CONSOLE) || defined(CONFIG_CONSOLE_POLL)
2120 * uart_console_write - write a console message to a serial port
2121 * @port: the port to write the message
2122 * @s: array of characters
2123 * @count: number of characters in string to write
2124 * @putchar: function to write character to port
2126 void uart_console_write(struct uart_port *port, const char *s,
2128 void (*putchar)(struct uart_port *, unsigned char))
2132 for (i = 0; i < count; i++, s++) {
2134 putchar(port, '\r');
2138 EXPORT_SYMBOL_GPL(uart_console_write);
2141 * uart_get_console - get uart port for console
2142 * @ports: ports to search in
2143 * @nr: number of @ports
2144 * @co: console to search for
2145 * Returns: uart_port for the console @co
2147 * Check whether an invalid uart number has been specified (as @co->index), and
2148 * if so, search for the first available port that does have console support.
2150 struct uart_port * __init
2151 uart_get_console(struct uart_port *ports, int nr, struct console *co)
2153 int idx = co->index;
2155 if (idx < 0 || idx >= nr || (ports[idx].iobase == 0 &&
2156 ports[idx].membase == NULL))
2157 for (idx = 0; idx < nr; idx++)
2158 if (ports[idx].iobase != 0 ||
2159 ports[idx].membase != NULL)
2168 * uart_parse_earlycon - Parse earlycon options
2169 * @p: ptr to 2nd field (ie., just beyond '<name>,')
2170 * @iotype: ptr for decoded iotype (out)
2171 * @addr: ptr for decoded mapbase/iobase (out)
2172 * @options: ptr for <options> field; %NULL if not present (out)
2174 * Decodes earlycon kernel command line parameters of the form:
2175 * * earlycon=<name>,io|mmio|mmio16|mmio32|mmio32be|mmio32native,<addr>,<options>
2176 * * console=<name>,io|mmio|mmio16|mmio32|mmio32be|mmio32native,<addr>,<options>
2178 * The optional form:
2179 * * earlycon=<name>,0x<addr>,<options>
2180 * * console=<name>,0x<addr>,<options>
2182 * is also accepted; the returned @iotype will be %UPIO_MEM.
2184 * Returns: 0 on success or -%EINVAL on failure
2186 int uart_parse_earlycon(char *p, unsigned char *iotype, resource_size_t *addr,
2189 if (strncmp(p, "mmio,", 5) == 0) {
2192 } else if (strncmp(p, "mmio16,", 7) == 0) {
2193 *iotype = UPIO_MEM16;
2195 } else if (strncmp(p, "mmio32,", 7) == 0) {
2196 *iotype = UPIO_MEM32;
2198 } else if (strncmp(p, "mmio32be,", 9) == 0) {
2199 *iotype = UPIO_MEM32BE;
2201 } else if (strncmp(p, "mmio32native,", 13) == 0) {
2202 *iotype = IS_ENABLED(CONFIG_CPU_BIG_ENDIAN) ?
2203 UPIO_MEM32BE : UPIO_MEM32;
2205 } else if (strncmp(p, "io,", 3) == 0) {
2206 *iotype = UPIO_PORT;
2208 } else if (strncmp(p, "0x", 2) == 0) {
2215 * Before you replace it with kstrtoull(), think about options separator
2216 * (',') it will not tolerate
2218 *addr = simple_strtoull(p, NULL, 0);
2226 EXPORT_SYMBOL_GPL(uart_parse_earlycon);
2229 * uart_parse_options - Parse serial port baud/parity/bits/flow control.
2230 * @options: pointer to option string
2231 * @baud: pointer to an 'int' variable for the baud rate.
2232 * @parity: pointer to an 'int' variable for the parity.
2233 * @bits: pointer to an 'int' variable for the number of data bits.
2234 * @flow: pointer to an 'int' variable for the flow control character.
2236 * uart_parse_options() decodes a string containing the serial console
2237 * options. The format of the string is <baud><parity><bits><flow>,
2241 uart_parse_options(const char *options, int *baud, int *parity,
2242 int *bits, int *flow)
2244 const char *s = options;
2246 *baud = simple_strtoul(s, NULL, 10);
2247 while (*s >= '0' && *s <= '9')
2256 EXPORT_SYMBOL_GPL(uart_parse_options);
2259 * uart_set_options - setup the serial console parameters
2260 * @port: pointer to the serial ports uart_port structure
2261 * @co: console pointer
2263 * @parity: parity character - 'n' (none), 'o' (odd), 'e' (even)
2264 * @bits: number of data bits
2265 * @flow: flow control character - 'r' (rts)
2267 * Locking: Caller must hold console_list_lock in order to serialize
2268 * early initialization of the serial-console lock.
2271 uart_set_options(struct uart_port *port, struct console *co,
2272 int baud, int parity, int bits, int flow)
2274 struct ktermios termios;
2275 static struct ktermios dummy;
2278 * Ensure that the serial-console lock is initialised early.
2280 * Note that the console-registered check is needed because
2281 * kgdboc can call uart_set_options() for an already registered
2282 * console via tty_find_polling_driver() and uart_poll_init().
2284 if (!uart_console_registered_locked(port) && !port->console_reinit)
2285 uart_port_spin_lock_init(port);
2287 memset(&termios, 0, sizeof(struct ktermios));
2289 termios.c_cflag |= CREAD | HUPCL | CLOCAL;
2290 tty_termios_encode_baud_rate(&termios, baud, baud);
2293 termios.c_cflag |= CS7;
2295 termios.c_cflag |= CS8;
2299 termios.c_cflag |= PARODD;
2302 termios.c_cflag |= PARENB;
2307 termios.c_cflag |= CRTSCTS;
2310 * some uarts on other side don't support no flow control.
2311 * So we set * DTR in host uart to make them happy
2313 port->mctrl |= TIOCM_DTR;
2315 port->ops->set_termios(port, &termios, &dummy);
2317 * Allow the setting of the UART parameters with a NULL console
2321 co->cflag = termios.c_cflag;
2322 co->ispeed = termios.c_ispeed;
2323 co->ospeed = termios.c_ospeed;
2328 EXPORT_SYMBOL_GPL(uart_set_options);
2329 #endif /* CONFIG_SERIAL_CORE_CONSOLE */
2332 * uart_change_pm - set power state of the port
2334 * @state: port descriptor
2335 * @pm_state: new state
2337 * Locking: port->mutex has to be held
2339 static void uart_change_pm(struct uart_state *state,
2340 enum uart_pm_state pm_state)
2342 struct uart_port *port = uart_port_check(state);
2344 if (state->pm_state != pm_state) {
2345 if (port && port->ops->pm)
2346 port->ops->pm(port, pm_state, state->pm_state);
2347 state->pm_state = pm_state;
2352 struct uart_port *port;
2353 struct uart_driver *driver;
2356 static int serial_match_port(struct device *dev, void *data)
2358 struct uart_match *match = data;
2359 struct tty_driver *tty_drv = match->driver->tty_driver;
2360 dev_t devt = MKDEV(tty_drv->major, tty_drv->minor_start) +
2363 return dev->devt == devt; /* Actually, only one tty per port */
2366 int uart_suspend_port(struct uart_driver *drv, struct uart_port *uport)
2368 struct uart_state *state = drv->state + uport->line;
2369 struct tty_port *port = &state->port;
2370 struct device *tty_dev;
2371 struct uart_match match = {uport, drv};
2373 mutex_lock(&port->mutex);
2375 tty_dev = device_find_child(uport->dev, &match, serial_match_port);
2376 if (tty_dev && device_may_wakeup(tty_dev)) {
2377 enable_irq_wake(uport->irq);
2378 put_device(tty_dev);
2379 mutex_unlock(&port->mutex);
2382 put_device(tty_dev);
2385 * Nothing to do if the console is not suspending
2386 * except stop_rx to prevent any asynchronous data
2387 * over RX line. However ensure that we will be
2388 * able to Re-start_rx later.
2390 if (!console_suspend_enabled && uart_console(uport)) {
2391 if (uport->ops->start_rx) {
2392 uart_port_lock_irq(uport);
2393 uport->ops->stop_rx(uport);
2394 uart_port_unlock_irq(uport);
2399 uport->suspended = 1;
2401 if (tty_port_initialized(port)) {
2402 const struct uart_ops *ops = uport->ops;
2406 tty_port_set_suspended(port, true);
2407 tty_port_set_initialized(port, false);
2409 uart_port_lock_irq(uport);
2410 ops->stop_tx(uport);
2411 if (!(uport->rs485.flags & SER_RS485_ENABLED))
2412 ops->set_mctrl(uport, 0);
2413 /* save mctrl so it can be restored on resume */
2414 mctrl = uport->mctrl;
2416 ops->stop_rx(uport);
2417 uart_port_unlock_irq(uport);
2420 * Wait for the transmitter to empty.
2422 for (tries = 3; !ops->tx_empty(uport) && tries; tries--)
2425 dev_err(uport->dev, "%s: Unable to drain transmitter\n",
2428 ops->shutdown(uport);
2429 uport->mctrl = mctrl;
2433 * Disable the console device before suspending.
2435 if (uart_console(uport))
2436 console_stop(uport->cons);
2438 uart_change_pm(state, UART_PM_STATE_OFF);
2440 mutex_unlock(&port->mutex);
2444 EXPORT_SYMBOL(uart_suspend_port);
2446 int uart_resume_port(struct uart_driver *drv, struct uart_port *uport)
2448 struct uart_state *state = drv->state + uport->line;
2449 struct tty_port *port = &state->port;
2450 struct device *tty_dev;
2451 struct uart_match match = {uport, drv};
2452 struct ktermios termios;
2454 mutex_lock(&port->mutex);
2456 tty_dev = device_find_child(uport->dev, &match, serial_match_port);
2457 if (!uport->suspended && device_may_wakeup(tty_dev)) {
2458 if (irqd_is_wakeup_set(irq_get_irq_data((uport->irq))))
2459 disable_irq_wake(uport->irq);
2460 put_device(tty_dev);
2461 mutex_unlock(&port->mutex);
2464 put_device(tty_dev);
2465 uport->suspended = 0;
2468 * Re-enable the console device after suspending.
2470 if (uart_console(uport)) {
2472 * First try to use the console cflag setting.
2474 memset(&termios, 0, sizeof(struct ktermios));
2475 termios.c_cflag = uport->cons->cflag;
2476 termios.c_ispeed = uport->cons->ispeed;
2477 termios.c_ospeed = uport->cons->ospeed;
2480 * If that's unset, use the tty termios setting.
2482 if (port->tty && termios.c_cflag == 0)
2483 termios = port->tty->termios;
2485 if (console_suspend_enabled)
2486 uart_change_pm(state, UART_PM_STATE_ON);
2487 uport->ops->set_termios(uport, &termios, NULL);
2488 if (!console_suspend_enabled && uport->ops->start_rx) {
2489 uart_port_lock_irq(uport);
2490 uport->ops->start_rx(uport);
2491 uart_port_unlock_irq(uport);
2493 if (console_suspend_enabled)
2494 console_start(uport->cons);
2497 if (tty_port_suspended(port)) {
2498 const struct uart_ops *ops = uport->ops;
2501 uart_change_pm(state, UART_PM_STATE_ON);
2502 uart_port_lock_irq(uport);
2503 if (!(uport->rs485.flags & SER_RS485_ENABLED))
2504 ops->set_mctrl(uport, 0);
2505 uart_port_unlock_irq(uport);
2506 if (console_suspend_enabled || !uart_console(uport)) {
2507 /* Protected by port mutex for now */
2508 struct tty_struct *tty = port->tty;
2510 ret = ops->startup(uport);
2513 uart_change_line_settings(tty, state, NULL);
2514 uart_rs485_config(uport);
2515 uart_port_lock_irq(uport);
2516 if (!(uport->rs485.flags & SER_RS485_ENABLED))
2517 ops->set_mctrl(uport, uport->mctrl);
2518 ops->start_tx(uport);
2519 uart_port_unlock_irq(uport);
2520 tty_port_set_initialized(port, true);
2523 * Failed to resume - maybe hardware went away?
2524 * Clear the "initialized" flag so we won't try
2525 * to call the low level drivers shutdown method.
2527 uart_shutdown(tty, state);
2531 tty_port_set_suspended(port, false);
2534 mutex_unlock(&port->mutex);
2538 EXPORT_SYMBOL(uart_resume_port);
2541 uart_report_port(struct uart_driver *drv, struct uart_port *port)
2545 switch (port->iotype) {
2547 snprintf(address, sizeof(address), "I/O 0x%lx", port->iobase);
2550 snprintf(address, sizeof(address),
2551 "I/O 0x%lx offset 0x%x", port->iobase, port->hub6);
2559 snprintf(address, sizeof(address),
2560 "MMIO 0x%llx", (unsigned long long)port->mapbase);
2563 strscpy(address, "*unknown*", sizeof(address));
2567 pr_info("%s%s%s at %s (irq = %d, base_baud = %d) is a %s\n",
2568 port->dev ? dev_name(port->dev) : "",
2569 port->dev ? ": " : "",
2571 address, port->irq, port->uartclk / 16, uart_type(port));
2573 /* The magic multiplier feature is a bit obscure, so report it too. */
2574 if (port->flags & UPF_MAGIC_MULTIPLIER)
2575 pr_info("%s%s%s extra baud rates supported: %d, %d",
2576 port->dev ? dev_name(port->dev) : "",
2577 port->dev ? ": " : "",
2579 port->uartclk / 8, port->uartclk / 4);
2583 uart_configure_port(struct uart_driver *drv, struct uart_state *state,
2584 struct uart_port *port)
2589 * If there isn't a port here, don't do anything further.
2591 if (!port->iobase && !port->mapbase && !port->membase)
2595 * Now do the auto configuration stuff. Note that config_port
2596 * is expected to claim the resources and map the port for us.
2599 if (port->flags & UPF_AUTO_IRQ)
2600 flags |= UART_CONFIG_IRQ;
2601 if (port->flags & UPF_BOOT_AUTOCONF) {
2602 if (!(port->flags & UPF_FIXED_TYPE)) {
2603 port->type = PORT_UNKNOWN;
2604 flags |= UART_CONFIG_TYPE;
2606 port->ops->config_port(port, flags);
2609 if (port->type != PORT_UNKNOWN) {
2610 unsigned long flags;
2612 uart_report_port(drv, port);
2614 /* Power up port for set_mctrl() */
2615 uart_change_pm(state, UART_PM_STATE_ON);
2618 * Ensure that the modem control lines are de-activated.
2619 * keep the DTR setting that is set in uart_set_options()
2620 * We probably don't need a spinlock around this, but
2622 uart_port_lock_irqsave(port, &flags);
2623 port->mctrl &= TIOCM_DTR;
2624 if (!(port->rs485.flags & SER_RS485_ENABLED))
2625 port->ops->set_mctrl(port, port->mctrl);
2626 uart_port_unlock_irqrestore(port, flags);
2628 uart_rs485_config(port);
2631 * If this driver supports console, and it hasn't been
2632 * successfully registered yet, try to re-register it.
2633 * It may be that the port was not available.
2635 if (port->cons && !console_is_registered(port->cons))
2636 register_console(port->cons);
2639 * Power down all ports by default, except the
2640 * console if we have one.
2642 if (!uart_console(port))
2643 uart_change_pm(state, UART_PM_STATE_OFF);
2647 #ifdef CONFIG_CONSOLE_POLL
2649 static int uart_poll_init(struct tty_driver *driver, int line, char *options)
2651 struct uart_driver *drv = driver->driver_state;
2652 struct uart_state *state = drv->state + line;
2653 enum uart_pm_state pm_state;
2654 struct tty_port *tport;
2655 struct uart_port *port;
2662 tport = &state->port;
2663 mutex_lock(&tport->mutex);
2665 port = uart_port_check(state);
2666 if (!port || !(port->ops->poll_get_char && port->ops->poll_put_char)) {
2671 pm_state = state->pm_state;
2672 uart_change_pm(state, UART_PM_STATE_ON);
2674 if (port->ops->poll_init) {
2676 * We don't set initialized as we only initialized the hw,
2677 * e.g. state->xmit is still uninitialized.
2679 if (!tty_port_initialized(tport))
2680 ret = port->ops->poll_init(port);
2683 if (!ret && options) {
2684 uart_parse_options(options, &baud, &parity, &bits, &flow);
2685 console_list_lock();
2686 ret = uart_set_options(port, NULL, baud, parity, bits, flow);
2687 console_list_unlock();
2691 uart_change_pm(state, pm_state);
2692 mutex_unlock(&tport->mutex);
2696 static int uart_poll_get_char(struct tty_driver *driver, int line)
2698 struct uart_driver *drv = driver->driver_state;
2699 struct uart_state *state = drv->state + line;
2700 struct uart_port *port;
2703 port = uart_port_ref(state);
2705 ret = port->ops->poll_get_char(port);
2706 uart_port_deref(port);
2712 static void uart_poll_put_char(struct tty_driver *driver, int line, char ch)
2714 struct uart_driver *drv = driver->driver_state;
2715 struct uart_state *state = drv->state + line;
2716 struct uart_port *port;
2718 port = uart_port_ref(state);
2723 port->ops->poll_put_char(port, '\r');
2724 port->ops->poll_put_char(port, ch);
2725 uart_port_deref(port);
2729 static const struct tty_operations uart_ops = {
2730 .install = uart_install,
2732 .close = uart_close,
2733 .write = uart_write,
2734 .put_char = uart_put_char,
2735 .flush_chars = uart_flush_chars,
2736 .write_room = uart_write_room,
2737 .chars_in_buffer= uart_chars_in_buffer,
2738 .flush_buffer = uart_flush_buffer,
2739 .ioctl = uart_ioctl,
2740 .throttle = uart_throttle,
2741 .unthrottle = uart_unthrottle,
2742 .send_xchar = uart_send_xchar,
2743 .set_termios = uart_set_termios,
2744 .set_ldisc = uart_set_ldisc,
2746 .start = uart_start,
2747 .hangup = uart_hangup,
2748 .break_ctl = uart_break_ctl,
2749 .wait_until_sent= uart_wait_until_sent,
2750 #ifdef CONFIG_PROC_FS
2751 .proc_show = uart_proc_show,
2753 .tiocmget = uart_tiocmget,
2754 .tiocmset = uart_tiocmset,
2755 .set_serial = uart_set_info_user,
2756 .get_serial = uart_get_info_user,
2757 .get_icount = uart_get_icount,
2758 #ifdef CONFIG_CONSOLE_POLL
2759 .poll_init = uart_poll_init,
2760 .poll_get_char = uart_poll_get_char,
2761 .poll_put_char = uart_poll_put_char,
2765 static const struct tty_port_operations uart_port_ops = {
2766 .carrier_raised = uart_carrier_raised,
2767 .dtr_rts = uart_dtr_rts,
2768 .activate = uart_port_activate,
2769 .shutdown = uart_tty_port_shutdown,
2773 * uart_register_driver - register a driver with the uart core layer
2774 * @drv: low level driver structure
2776 * Register a uart driver with the core driver. We in turn register with the
2777 * tty layer, and initialise the core driver per-port state.
2779 * We have a proc file in /proc/tty/driver which is named after the normal
2782 * @drv->port should be %NULL, and the per-port structures should be registered
2783 * using uart_add_one_port() after this call has succeeded.
2785 * Locking: none, Interrupts: enabled
2787 int uart_register_driver(struct uart_driver *drv)
2789 struct tty_driver *normal;
2790 int i, retval = -ENOMEM;
2795 * Maybe we should be using a slab cache for this, especially if
2796 * we have a large number of ports to handle.
2798 drv->state = kcalloc(drv->nr, sizeof(struct uart_state), GFP_KERNEL);
2802 normal = tty_alloc_driver(drv->nr, TTY_DRIVER_REAL_RAW |
2803 TTY_DRIVER_DYNAMIC_DEV);
2804 if (IS_ERR(normal)) {
2805 retval = PTR_ERR(normal);
2809 drv->tty_driver = normal;
2811 normal->driver_name = drv->driver_name;
2812 normal->name = drv->dev_name;
2813 normal->major = drv->major;
2814 normal->minor_start = drv->minor;
2815 normal->type = TTY_DRIVER_TYPE_SERIAL;
2816 normal->subtype = SERIAL_TYPE_NORMAL;
2817 normal->init_termios = tty_std_termios;
2818 normal->init_termios.c_cflag = B9600 | CS8 | CREAD | HUPCL | CLOCAL;
2819 normal->init_termios.c_ispeed = normal->init_termios.c_ospeed = 9600;
2820 normal->driver_state = drv;
2821 tty_set_operations(normal, &uart_ops);
2824 * Initialise the UART state(s).
2826 for (i = 0; i < drv->nr; i++) {
2827 struct uart_state *state = drv->state + i;
2828 struct tty_port *port = &state->port;
2830 tty_port_init(port);
2831 port->ops = &uart_port_ops;
2834 retval = tty_register_driver(normal);
2838 for (i = 0; i < drv->nr; i++)
2839 tty_port_destroy(&drv->state[i].port);
2840 tty_driver_kref_put(normal);
2846 EXPORT_SYMBOL(uart_register_driver);
2849 * uart_unregister_driver - remove a driver from the uart core layer
2850 * @drv: low level driver structure
2852 * Remove all references to a driver from the core driver. The low level
2853 * driver must have removed all its ports via the uart_remove_one_port() if it
2854 * registered them with uart_add_one_port(). (I.e. @drv->port is %NULL.)
2856 * Locking: none, Interrupts: enabled
2858 void uart_unregister_driver(struct uart_driver *drv)
2860 struct tty_driver *p = drv->tty_driver;
2863 tty_unregister_driver(p);
2864 tty_driver_kref_put(p);
2865 for (i = 0; i < drv->nr; i++)
2866 tty_port_destroy(&drv->state[i].port);
2869 drv->tty_driver = NULL;
2871 EXPORT_SYMBOL(uart_unregister_driver);
2873 struct tty_driver *uart_console_device(struct console *co, int *index)
2875 struct uart_driver *p = co->data;
2877 return p->tty_driver;
2879 EXPORT_SYMBOL_GPL(uart_console_device);
2881 static ssize_t uartclk_show(struct device *dev,
2882 struct device_attribute *attr, char *buf)
2884 struct serial_struct tmp;
2885 struct tty_port *port = dev_get_drvdata(dev);
2887 uart_get_info(port, &tmp);
2888 return sprintf(buf, "%d\n", tmp.baud_base * 16);
2891 static ssize_t type_show(struct device *dev,
2892 struct device_attribute *attr, char *buf)
2894 struct serial_struct tmp;
2895 struct tty_port *port = dev_get_drvdata(dev);
2897 uart_get_info(port, &tmp);
2898 return sprintf(buf, "%d\n", tmp.type);
2901 static ssize_t line_show(struct device *dev,
2902 struct device_attribute *attr, char *buf)
2904 struct serial_struct tmp;
2905 struct tty_port *port = dev_get_drvdata(dev);
2907 uart_get_info(port, &tmp);
2908 return sprintf(buf, "%d\n", tmp.line);
2911 static ssize_t port_show(struct device *dev,
2912 struct device_attribute *attr, char *buf)
2914 struct serial_struct tmp;
2915 struct tty_port *port = dev_get_drvdata(dev);
2916 unsigned long ioaddr;
2918 uart_get_info(port, &tmp);
2920 if (HIGH_BITS_OFFSET)
2921 ioaddr |= (unsigned long)tmp.port_high << HIGH_BITS_OFFSET;
2922 return sprintf(buf, "0x%lX\n", ioaddr);
2925 static ssize_t irq_show(struct device *dev,
2926 struct device_attribute *attr, char *buf)
2928 struct serial_struct tmp;
2929 struct tty_port *port = dev_get_drvdata(dev);
2931 uart_get_info(port, &tmp);
2932 return sprintf(buf, "%d\n", tmp.irq);
2935 static ssize_t flags_show(struct device *dev,
2936 struct device_attribute *attr, char *buf)
2938 struct serial_struct tmp;
2939 struct tty_port *port = dev_get_drvdata(dev);
2941 uart_get_info(port, &tmp);
2942 return sprintf(buf, "0x%X\n", tmp.flags);
2945 static ssize_t xmit_fifo_size_show(struct device *dev,
2946 struct device_attribute *attr, char *buf)
2948 struct serial_struct tmp;
2949 struct tty_port *port = dev_get_drvdata(dev);
2951 uart_get_info(port, &tmp);
2952 return sprintf(buf, "%d\n", tmp.xmit_fifo_size);
2955 static ssize_t close_delay_show(struct device *dev,
2956 struct device_attribute *attr, char *buf)
2958 struct serial_struct tmp;
2959 struct tty_port *port = dev_get_drvdata(dev);
2961 uart_get_info(port, &tmp);
2962 return sprintf(buf, "%d\n", tmp.close_delay);
2965 static ssize_t closing_wait_show(struct device *dev,
2966 struct device_attribute *attr, char *buf)
2968 struct serial_struct tmp;
2969 struct tty_port *port = dev_get_drvdata(dev);
2971 uart_get_info(port, &tmp);
2972 return sprintf(buf, "%d\n", tmp.closing_wait);
2975 static ssize_t custom_divisor_show(struct device *dev,
2976 struct device_attribute *attr, char *buf)
2978 struct serial_struct tmp;
2979 struct tty_port *port = dev_get_drvdata(dev);
2981 uart_get_info(port, &tmp);
2982 return sprintf(buf, "%d\n", tmp.custom_divisor);
2985 static ssize_t io_type_show(struct device *dev,
2986 struct device_attribute *attr, char *buf)
2988 struct serial_struct tmp;
2989 struct tty_port *port = dev_get_drvdata(dev);
2991 uart_get_info(port, &tmp);
2992 return sprintf(buf, "%d\n", tmp.io_type);
2995 static ssize_t iomem_base_show(struct device *dev,
2996 struct device_attribute *attr, char *buf)
2998 struct serial_struct tmp;
2999 struct tty_port *port = dev_get_drvdata(dev);
3001 uart_get_info(port, &tmp);
3002 return sprintf(buf, "0x%lX\n", (unsigned long)tmp.iomem_base);
3005 static ssize_t iomem_reg_shift_show(struct device *dev,
3006 struct device_attribute *attr, char *buf)
3008 struct serial_struct tmp;
3009 struct tty_port *port = dev_get_drvdata(dev);
3011 uart_get_info(port, &tmp);
3012 return sprintf(buf, "%d\n", tmp.iomem_reg_shift);
3015 static ssize_t console_show(struct device *dev,
3016 struct device_attribute *attr, char *buf)
3018 struct tty_port *port = dev_get_drvdata(dev);
3019 struct uart_state *state = container_of(port, struct uart_state, port);
3020 struct uart_port *uport;
3021 bool console = false;
3023 mutex_lock(&port->mutex);
3024 uport = uart_port_check(state);
3026 console = uart_console_registered(uport);
3027 mutex_unlock(&port->mutex);
3029 return sprintf(buf, "%c\n", console ? 'Y' : 'N');
3032 static ssize_t console_store(struct device *dev,
3033 struct device_attribute *attr, const char *buf, size_t count)
3035 struct tty_port *port = dev_get_drvdata(dev);
3036 struct uart_state *state = container_of(port, struct uart_state, port);
3037 struct uart_port *uport;
3038 bool oldconsole, newconsole;
3041 ret = kstrtobool(buf, &newconsole);
3045 mutex_lock(&port->mutex);
3046 uport = uart_port_check(state);
3048 oldconsole = uart_console_registered(uport);
3049 if (oldconsole && !newconsole) {
3050 ret = unregister_console(uport->cons);
3051 } else if (!oldconsole && newconsole) {
3052 if (uart_console(uport)) {
3053 uport->console_reinit = 1;
3054 register_console(uport->cons);
3062 mutex_unlock(&port->mutex);
3064 return ret < 0 ? ret : count;
3067 static DEVICE_ATTR_RO(uartclk);
3068 static DEVICE_ATTR_RO(type);
3069 static DEVICE_ATTR_RO(line);
3070 static DEVICE_ATTR_RO(port);
3071 static DEVICE_ATTR_RO(irq);
3072 static DEVICE_ATTR_RO(flags);
3073 static DEVICE_ATTR_RO(xmit_fifo_size);
3074 static DEVICE_ATTR_RO(close_delay);
3075 static DEVICE_ATTR_RO(closing_wait);
3076 static DEVICE_ATTR_RO(custom_divisor);
3077 static DEVICE_ATTR_RO(io_type);
3078 static DEVICE_ATTR_RO(iomem_base);
3079 static DEVICE_ATTR_RO(iomem_reg_shift);
3080 static DEVICE_ATTR_RW(console);
3082 static struct attribute *tty_dev_attrs[] = {
3083 &dev_attr_uartclk.attr,
3084 &dev_attr_type.attr,
3085 &dev_attr_line.attr,
3086 &dev_attr_port.attr,
3088 &dev_attr_flags.attr,
3089 &dev_attr_xmit_fifo_size.attr,
3090 &dev_attr_close_delay.attr,
3091 &dev_attr_closing_wait.attr,
3092 &dev_attr_custom_divisor.attr,
3093 &dev_attr_io_type.attr,
3094 &dev_attr_iomem_base.attr,
3095 &dev_attr_iomem_reg_shift.attr,
3096 &dev_attr_console.attr,
3100 static const struct attribute_group tty_dev_attr_group = {
3101 .attrs = tty_dev_attrs,
3105 * serial_core_add_one_port - attach a driver-defined port structure
3106 * @drv: pointer to the uart low level driver structure for this port
3107 * @uport: uart port structure to use for this port.
3109 * Context: task context, might sleep
3111 * This allows the driver @drv to register its own uart_port structure with the
3112 * core driver. The main purpose is to allow the low level uart drivers to
3113 * expand uart_port, rather than having yet more levels of structures.
3114 * Caller must hold port_mutex.
3116 static int serial_core_add_one_port(struct uart_driver *drv, struct uart_port *uport)
3118 struct uart_state *state;
3119 struct tty_port *port;
3121 struct device *tty_dev;
3124 if (uport->line >= drv->nr)
3127 state = drv->state + uport->line;
3128 port = &state->port;
3130 mutex_lock(&port->mutex);
3131 if (state->uart_port) {
3136 /* Link the port to the driver state table and vice versa */
3137 atomic_set(&state->refcount, 1);
3138 init_waitqueue_head(&state->remove_wait);
3139 state->uart_port = uport;
3140 uport->state = state;
3142 state->pm_state = UART_PM_STATE_UNDEFINED;
3143 uport->cons = drv->cons;
3144 uport->minor = drv->tty_driver->minor_start + uport->line;
3145 uport->name = kasprintf(GFP_KERNEL, "%s%d", drv->dev_name,
3146 drv->tty_driver->name_base + uport->line);
3153 * If this port is in use as a console then the spinlock is already
3156 if (!uart_console_registered(uport))
3157 uart_port_spin_lock_init(uport);
3159 if (uport->cons && uport->dev)
3160 of_console_check(uport->dev->of_node, uport->cons->name, uport->line);
3162 tty_port_link_device(port, drv->tty_driver, uport->line);
3163 uart_configure_port(drv, state, uport);
3165 port->console = uart_console(uport);
3168 if (uport->attr_group)
3171 uport->tty_groups = kcalloc(num_groups, sizeof(*uport->tty_groups),
3173 if (!uport->tty_groups) {
3177 uport->tty_groups[0] = &tty_dev_attr_group;
3178 if (uport->attr_group)
3179 uport->tty_groups[1] = uport->attr_group;
3182 * Register the port whether it's detected or not. This allows
3183 * setserial to be used to alter this port's parameters.
3185 tty_dev = tty_port_register_device_attr_serdev(port, drv->tty_driver,
3186 uport->line, uport->dev, port, uport->tty_groups);
3187 if (!IS_ERR(tty_dev)) {
3188 device_set_wakeup_capable(tty_dev, 1);
3190 dev_err(uport->dev, "Cannot register tty device on line %d\n",
3195 mutex_unlock(&port->mutex);
3201 * serial_core_remove_one_port - detach a driver defined port structure
3202 * @drv: pointer to the uart low level driver structure for this port
3203 * @uport: uart port structure for this port
3205 * Context: task context, might sleep
3207 * This unhooks (and hangs up) the specified port structure from the core
3208 * driver. No further calls will be made to the low-level code for this port.
3209 * Caller must hold port_mutex.
3211 static void serial_core_remove_one_port(struct uart_driver *drv,
3212 struct uart_port *uport)
3214 struct uart_state *state = drv->state + uport->line;
3215 struct tty_port *port = &state->port;
3216 struct uart_port *uart_port;
3217 struct tty_struct *tty;
3219 mutex_lock(&port->mutex);
3220 uart_port = uart_port_check(state);
3221 if (uart_port != uport)
3222 dev_alert(uport->dev, "Removing wrong port: %p != %p\n",
3226 mutex_unlock(&port->mutex);
3229 mutex_unlock(&port->mutex);
3232 * Remove the devices from the tty layer
3234 tty_port_unregister_device(port, drv->tty_driver, uport->line);
3236 tty = tty_port_tty_get(port);
3238 tty_vhangup(port->tty);
3243 * If the port is used as a console, unregister it
3245 if (uart_console(uport))
3246 unregister_console(uport->cons);
3249 * Free the port IO and memory resources, if any.
3251 if (uport->type != PORT_UNKNOWN && uport->ops->release_port)
3252 uport->ops->release_port(uport);
3253 kfree(uport->tty_groups);
3257 * Indicate that there isn't a port here anymore.
3259 uport->type = PORT_UNKNOWN;
3260 uport->port_dev = NULL;
3262 mutex_lock(&port->mutex);
3263 WARN_ON(atomic_dec_return(&state->refcount) < 0);
3264 wait_event(state->remove_wait, !atomic_read(&state->refcount));
3265 state->uart_port = NULL;
3266 mutex_unlock(&port->mutex);
3270 * uart_match_port - are the two ports equivalent?
3271 * @port1: first port
3272 * @port2: second port
3274 * This utility function can be used to determine whether two uart_port
3275 * structures describe the same port.
3277 bool uart_match_port(const struct uart_port *port1,
3278 const struct uart_port *port2)
3280 if (port1->iotype != port2->iotype)
3283 switch (port1->iotype) {
3285 return port1->iobase == port2->iobase;
3287 return port1->iobase == port2->iobase &&
3288 port1->hub6 == port2->hub6;
3295 return port1->mapbase == port2->mapbase;
3300 EXPORT_SYMBOL(uart_match_port);
3302 static struct serial_ctrl_device *
3303 serial_core_get_ctrl_dev(struct serial_port_device *port_dev)
3305 struct device *dev = &port_dev->dev;
3307 return to_serial_base_ctrl_device(dev->parent);
3311 * Find a registered serial core controller device if one exists. Returns
3312 * the first device matching the ctrl_id. Caller must hold port_mutex.
3314 static struct serial_ctrl_device *serial_core_ctrl_find(struct uart_driver *drv,
3315 struct device *phys_dev,
3318 struct uart_state *state;
3321 lockdep_assert_held(&port_mutex);
3323 for (i = 0; i < drv->nr; i++) {
3324 state = drv->state + i;
3325 if (!state->uart_port || !state->uart_port->port_dev)
3328 if (state->uart_port->dev == phys_dev &&
3329 state->uart_port->ctrl_id == ctrl_id)
3330 return serial_core_get_ctrl_dev(state->uart_port->port_dev);
3336 static struct serial_ctrl_device *serial_core_ctrl_device_add(struct uart_port *port)
3338 return serial_base_ctrl_add(port, port->dev);
3341 static int serial_core_port_device_add(struct serial_ctrl_device *ctrl_dev,
3342 struct uart_port *port)
3344 struct serial_port_device *port_dev;
3346 port_dev = serial_base_port_add(port, ctrl_dev);
3347 if (IS_ERR(port_dev))
3348 return PTR_ERR(port_dev);
3350 port->port_dev = port_dev;
3356 * Initialize a serial core port device, and a controller device if needed.
3358 int serial_core_register_port(struct uart_driver *drv, struct uart_port *port)
3360 struct serial_ctrl_device *ctrl_dev, *new_ctrl_dev = NULL;
3363 mutex_lock(&port_mutex);
3366 * Prevent serial_port_runtime_resume() from trying to use the port
3367 * until serial_core_add_one_port() has completed
3369 port->flags |= UPF_DEAD;
3371 /* Inititalize a serial core controller device if needed */
3372 ctrl_dev = serial_core_ctrl_find(drv, port->dev, port->ctrl_id);
3374 new_ctrl_dev = serial_core_ctrl_device_add(port);
3375 if (IS_ERR(new_ctrl_dev)) {
3376 ret = PTR_ERR(new_ctrl_dev);
3379 ctrl_dev = new_ctrl_dev;
3383 * Initialize a serial core port device. Tag the port dead to prevent
3384 * serial_port_runtime_resume() trying to do anything until port has
3385 * been registered. It gets cleared by serial_core_add_one_port().
3387 ret = serial_core_port_device_add(ctrl_dev, port);
3389 goto err_unregister_ctrl_dev;
3391 ret = serial_core_add_one_port(drv, port);
3393 goto err_unregister_port_dev;
3395 port->flags &= ~UPF_DEAD;
3397 mutex_unlock(&port_mutex);
3401 err_unregister_port_dev:
3402 serial_base_port_device_remove(port->port_dev);
3404 err_unregister_ctrl_dev:
3405 serial_base_ctrl_device_remove(new_ctrl_dev);
3408 mutex_unlock(&port_mutex);
3414 * Removes a serial core port device, and the related serial core controller
3415 * device if the last instance.
3417 void serial_core_unregister_port(struct uart_driver *drv, struct uart_port *port)
3419 struct device *phys_dev = port->dev;
3420 struct serial_port_device *port_dev = port->port_dev;
3421 struct serial_ctrl_device *ctrl_dev = serial_core_get_ctrl_dev(port_dev);
3422 int ctrl_id = port->ctrl_id;
3424 mutex_lock(&port_mutex);
3426 port->flags |= UPF_DEAD;
3428 serial_core_remove_one_port(drv, port);
3430 /* Note that struct uart_port *port is no longer valid at this point */
3431 serial_base_port_device_remove(port_dev);
3433 /* Drop the serial core controller device if no ports are using it */
3434 if (!serial_core_ctrl_find(drv, phys_dev, ctrl_id))
3435 serial_base_ctrl_device_remove(ctrl_dev);
3437 mutex_unlock(&port_mutex);
3441 * uart_handle_dcd_change - handle a change of carrier detect state
3442 * @uport: uart_port structure for the open port
3443 * @active: new carrier detect status
3445 * Caller must hold uport->lock.
3447 void uart_handle_dcd_change(struct uart_port *uport, bool active)
3449 struct tty_port *port = &uport->state->port;
3450 struct tty_struct *tty = port->tty;
3451 struct tty_ldisc *ld;
3453 lockdep_assert_held_once(&uport->lock);
3456 ld = tty_ldisc_ref(tty);
3458 if (ld->ops->dcd_change)
3459 ld->ops->dcd_change(tty, active);
3460 tty_ldisc_deref(ld);
3464 uport->icount.dcd++;
3466 if (uart_dcd_enabled(uport)) {
3468 wake_up_interruptible(&port->open_wait);
3473 EXPORT_SYMBOL_GPL(uart_handle_dcd_change);
3476 * uart_handle_cts_change - handle a change of clear-to-send state
3477 * @uport: uart_port structure for the open port
3478 * @active: new clear-to-send status
3480 * Caller must hold uport->lock.
3482 void uart_handle_cts_change(struct uart_port *uport, bool active)
3484 lockdep_assert_held_once(&uport->lock);
3486 uport->icount.cts++;
3488 if (uart_softcts_mode(uport)) {
3489 if (uport->hw_stopped) {
3491 uport->hw_stopped = false;
3492 uport->ops->start_tx(uport);
3493 uart_write_wakeup(uport);
3497 uport->hw_stopped = true;
3498 uport->ops->stop_tx(uport);
3504 EXPORT_SYMBOL_GPL(uart_handle_cts_change);
3507 * uart_insert_char - push a char to the uart layer
3509 * User is responsible to call tty_flip_buffer_push when they are done with
3512 * @port: corresponding port
3513 * @status: state of the serial port RX buffer (LSR for 8250)
3514 * @overrun: mask of overrun bits in @status
3515 * @ch: character to push
3516 * @flag: flag for the character (see TTY_NORMAL and friends)
3518 void uart_insert_char(struct uart_port *port, unsigned int status,
3519 unsigned int overrun, u8 ch, u8 flag)
3521 struct tty_port *tport = &port->state->port;
3523 if ((status & port->ignore_status_mask & ~overrun) == 0)
3524 if (tty_insert_flip_char(tport, ch, flag) == 0)
3525 ++port->icount.buf_overrun;
3528 * Overrun is special. Since it's reported immediately,
3529 * it doesn't affect the current character.
3531 if (status & ~port->ignore_status_mask & overrun)
3532 if (tty_insert_flip_char(tport, 0, TTY_OVERRUN) == 0)
3533 ++port->icount.buf_overrun;
3535 EXPORT_SYMBOL_GPL(uart_insert_char);
3537 #ifdef CONFIG_MAGIC_SYSRQ_SERIAL
3538 static const u8 sysrq_toggle_seq[] = CONFIG_MAGIC_SYSRQ_SERIAL_SEQUENCE;
3540 static void uart_sysrq_on(struct work_struct *w)
3542 int sysrq_toggle_seq_len = strlen(sysrq_toggle_seq);
3544 sysrq_toggle_support(1);
3545 pr_info("SysRq is enabled by magic sequence '%*pE' on serial\n",
3546 sysrq_toggle_seq_len, sysrq_toggle_seq);
3548 static DECLARE_WORK(sysrq_enable_work, uart_sysrq_on);
3551 * uart_try_toggle_sysrq - Enables SysRq from serial line
3552 * @port: uart_port structure where char(s) after BREAK met
3553 * @ch: new character in the sequence after received BREAK
3555 * Enables magic SysRq when the required sequence is met on port
3556 * (see CONFIG_MAGIC_SYSRQ_SERIAL_SEQUENCE).
3558 * Returns: %false if @ch is out of enabling sequence and should be
3559 * handled some other way, %true if @ch was consumed.
3561 bool uart_try_toggle_sysrq(struct uart_port *port, u8 ch)
3563 int sysrq_toggle_seq_len = strlen(sysrq_toggle_seq);
3565 if (!sysrq_toggle_seq_len)
3568 BUILD_BUG_ON(ARRAY_SIZE(sysrq_toggle_seq) >= U8_MAX);
3569 if (sysrq_toggle_seq[port->sysrq_seq] != ch) {
3570 port->sysrq_seq = 0;
3574 if (++port->sysrq_seq < sysrq_toggle_seq_len) {
3575 port->sysrq = jiffies + SYSRQ_TIMEOUT;
3579 schedule_work(&sysrq_enable_work);
3584 EXPORT_SYMBOL_GPL(uart_try_toggle_sysrq);
3588 * uart_get_rs485_mode() - retrieve rs485 properties for given uart
3589 * @port: uart device's target port
3591 * This function implements the device tree binding described in
3592 * Documentation/devicetree/bindings/serial/rs485.txt.
3594 int uart_get_rs485_mode(struct uart_port *port)
3596 struct serial_rs485 *rs485conf = &port->rs485;
3597 struct device *dev = port->dev;
3598 enum gpiod_flags dflags;
3599 struct gpio_desc *desc;
3603 if (!(port->rs485_supported.flags & SER_RS485_ENABLED))
3606 ret = device_property_read_u32_array(dev, "rs485-rts-delay",
3609 rs485conf->delay_rts_before_send = rs485_delay[0];
3610 rs485conf->delay_rts_after_send = rs485_delay[1];
3612 rs485conf->delay_rts_before_send = 0;
3613 rs485conf->delay_rts_after_send = 0;
3616 uart_sanitize_serial_rs485_delays(port, rs485conf);
3619 * Clear full-duplex and enabled flags, set RTS polarity to active high
3620 * to get to a defined state with the following properties:
3622 rs485conf->flags &= ~(SER_RS485_RX_DURING_TX | SER_RS485_ENABLED |
3623 SER_RS485_TERMINATE_BUS |
3624 SER_RS485_RTS_AFTER_SEND);
3625 rs485conf->flags |= SER_RS485_RTS_ON_SEND;
3627 if (device_property_read_bool(dev, "rs485-rx-during-tx"))
3628 rs485conf->flags |= SER_RS485_RX_DURING_TX;
3630 if (device_property_read_bool(dev, "linux,rs485-enabled-at-boot-time"))
3631 rs485conf->flags |= SER_RS485_ENABLED;
3633 if (device_property_read_bool(dev, "rs485-rts-active-low")) {
3634 rs485conf->flags &= ~SER_RS485_RTS_ON_SEND;
3635 rs485conf->flags |= SER_RS485_RTS_AFTER_SEND;
3639 * Disabling termination by default is the safe choice: Else if many
3640 * bus participants enable it, no communication is possible at all.
3641 * Works fine for short cables and users may enable for longer cables.
3643 desc = devm_gpiod_get_optional(dev, "rs485-term", GPIOD_OUT_LOW);
3645 return dev_err_probe(dev, PTR_ERR(desc), "Cannot get rs485-term-gpios\n");
3646 port->rs485_term_gpio = desc;
3647 if (port->rs485_term_gpio)
3648 port->rs485_supported.flags |= SER_RS485_TERMINATE_BUS;
3650 dflags = (rs485conf->flags & SER_RS485_RX_DURING_TX) ?
3651 GPIOD_OUT_HIGH : GPIOD_OUT_LOW;
3652 desc = devm_gpiod_get_optional(dev, "rs485-rx-during-tx", dflags);
3654 return dev_err_probe(dev, PTR_ERR(desc), "Cannot get rs485-rx-during-tx-gpios\n");
3655 port->rs485_rx_during_tx_gpio = desc;
3656 if (port->rs485_rx_during_tx_gpio)
3657 port->rs485_supported.flags |= SER_RS485_RX_DURING_TX;
3661 EXPORT_SYMBOL_GPL(uart_get_rs485_mode);
3663 /* Compile-time assertions for serial_rs485 layout */
3664 static_assert(offsetof(struct serial_rs485, padding) ==
3665 (offsetof(struct serial_rs485, delay_rts_after_send) + sizeof(__u32)));
3666 static_assert(offsetof(struct serial_rs485, padding1) ==
3667 offsetof(struct serial_rs485, padding[1]));
3668 static_assert((offsetof(struct serial_rs485, padding[4]) + sizeof(__u32)) ==
3669 sizeof(struct serial_rs485));
3671 MODULE_DESCRIPTION("Serial driver core");
3672 MODULE_LICENSE("GPL");