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>
18 #include <linux/proc_fs.h>
19 #include <linux/seq_file.h>
20 #include <linux/device.h>
21 #include <linux/serial.h> /* for serial_state and serial_icounter_struct */
22 #include <linux/serial_core.h>
23 #include <linux/delay.h>
24 #include <linux/mutex.h>
26 #include <linux/irq.h>
27 #include <linux/uaccess.h>
30 * This is used to lock changes in serial line configuration.
32 static DEFINE_MUTEX(port_mutex
);
35 * lockdep: port->lock is initialized in two places, but we
36 * want only one lock-class:
38 static struct lock_class_key port_lock_key
;
40 #define HIGH_BITS_OFFSET ((sizeof(long)-sizeof(int))*8)
42 static void uart_change_speed(struct tty_struct
*tty
, struct uart_state
*state
,
43 struct ktermios
*old_termios
);
44 static void uart_wait_until_sent(struct tty_struct
*tty
, int timeout
);
45 static void uart_change_pm(struct uart_state
*state
,
46 enum uart_pm_state pm_state
);
48 static void uart_port_shutdown(struct tty_port
*port
);
50 static int uart_dcd_enabled(struct uart_port
*uport
)
52 return !!(uport
->status
& UPSTAT_DCD_ENABLE
);
55 static inline struct uart_port
*uart_port_ref(struct uart_state
*state
)
57 if (atomic_add_unless(&state
->refcount
, 1, 0))
58 return state
->uart_port
;
62 static inline void uart_port_deref(struct uart_port
*uport
)
64 if (atomic_dec_and_test(&uport
->state
->refcount
))
65 wake_up(&uport
->state
->remove_wait
);
68 #define uart_port_lock(state, flags) \
70 struct uart_port *__uport = uart_port_ref(state); \
72 spin_lock_irqsave(&__uport->lock, flags); \
76 #define uart_port_unlock(uport, flags) \
78 struct uart_port *__uport = uport; \
80 spin_unlock_irqrestore(&__uport->lock, flags); \
81 uart_port_deref(__uport); \
85 static inline struct uart_port
*uart_port_check(struct uart_state
*state
)
87 lockdep_assert_held(&state
->port
.mutex
);
88 return state
->uart_port
;
92 * This routine is used by the interrupt handler to schedule processing in
93 * the software interrupt portion of the driver.
95 void uart_write_wakeup(struct uart_port
*port
)
97 struct uart_state
*state
= port
->state
;
99 * This means you called this function _after_ the port was
100 * closed. No cookie for you.
103 tty_port_tty_wakeup(&state
->port
);
106 static void uart_stop(struct tty_struct
*tty
)
108 struct uart_state
*state
= tty
->driver_data
;
109 struct uart_port
*port
;
112 port
= uart_port_lock(state
, flags
);
114 port
->ops
->stop_tx(port
);
115 uart_port_unlock(port
, flags
);
118 static void __uart_start(struct tty_struct
*tty
)
120 struct uart_state
*state
= tty
->driver_data
;
121 struct uart_port
*port
= state
->uart_port
;
123 if (port
&& !uart_tx_stopped(port
))
124 port
->ops
->start_tx(port
);
127 static void uart_start(struct tty_struct
*tty
)
129 struct uart_state
*state
= tty
->driver_data
;
130 struct uart_port
*port
;
133 port
= uart_port_lock(state
, flags
);
135 uart_port_unlock(port
, flags
);
139 uart_update_mctrl(struct uart_port
*port
, unsigned int set
, unsigned int clear
)
144 spin_lock_irqsave(&port
->lock
, flags
);
146 port
->mctrl
= (old
& ~clear
) | set
;
147 if (old
!= port
->mctrl
)
148 port
->ops
->set_mctrl(port
, port
->mctrl
);
149 spin_unlock_irqrestore(&port
->lock
, flags
);
152 #define uart_set_mctrl(port, set) uart_update_mctrl(port, set, 0)
153 #define uart_clear_mctrl(port, clear) uart_update_mctrl(port, 0, clear)
155 static void uart_port_dtr_rts(struct uart_port
*uport
, int raise
)
157 int rs485_on
= uport
->rs485_config
&&
158 (uport
->rs485
.flags
& SER_RS485_ENABLED
);
159 int RTS_after_send
= !!(uport
->rs485
.flags
& SER_RS485_RTS_AFTER_SEND
);
162 if (rs485_on
&& !RTS_after_send
) {
163 uart_set_mctrl(uport
, TIOCM_DTR
);
164 uart_clear_mctrl(uport
, TIOCM_RTS
);
166 uart_set_mctrl(uport
, TIOCM_DTR
| TIOCM_RTS
);
169 unsigned int clear
= TIOCM_DTR
;
171 clear
|= (!rs485_on
|| !RTS_after_send
) ? TIOCM_RTS
: 0;
172 uart_clear_mctrl(uport
, clear
);
177 * Startup the port. This will be called once per open. All calls
178 * will be serialised by the per-port mutex.
180 static int uart_port_startup(struct tty_struct
*tty
, struct uart_state
*state
,
183 struct uart_port
*uport
= uart_port_check(state
);
185 unsigned long flags
= 0;
188 if (uport
->type
== PORT_UNKNOWN
)
192 * Make sure the device is in D0 state.
194 uart_change_pm(state
, UART_PM_STATE_ON
);
197 * Initialise and allocate the transmit and temporary
200 page
= get_zeroed_page(GFP_KERNEL
);
204 uart_port_lock(state
, flags
);
205 if (!state
->xmit
.buf
) {
206 state
->xmit
.buf
= (unsigned char *) page
;
207 uart_circ_clear(&state
->xmit
);
208 uart_port_unlock(uport
, flags
);
210 uart_port_unlock(uport
, flags
);
212 * Do not free() the page under the port lock, see
218 retval
= uport
->ops
->startup(uport
);
220 if (uart_console(uport
) && uport
->cons
->cflag
) {
221 tty
->termios
.c_cflag
= uport
->cons
->cflag
;
222 uport
->cons
->cflag
= 0;
225 * Initialise the hardware port settings.
227 uart_change_speed(tty
, state
, NULL
);
230 * Setup the RTS and DTR signals once the
231 * port is open and ready to respond.
233 if (init_hw
&& C_BAUD(tty
))
234 uart_port_dtr_rts(uport
, 1);
238 * This is to allow setserial on this port. People may want to set
239 * port/irq/type and then reconfigure the port properly if it failed
242 if (retval
&& capable(CAP_SYS_ADMIN
))
248 static int uart_startup(struct tty_struct
*tty
, struct uart_state
*state
,
251 struct tty_port
*port
= &state
->port
;
254 if (tty_port_initialized(port
))
257 retval
= uart_port_startup(tty
, state
, init_hw
);
259 set_bit(TTY_IO_ERROR
, &tty
->flags
);
265 * This routine will shutdown a serial port; interrupts are disabled, and
266 * DTR is dropped if the hangup on close termio flag is on. Calls to
267 * uart_shutdown are serialised by the per-port semaphore.
269 * uport == NULL if uart_port has already been removed
271 static void uart_shutdown(struct tty_struct
*tty
, struct uart_state
*state
)
273 struct uart_port
*uport
= uart_port_check(state
);
274 struct tty_port
*port
= &state
->port
;
275 unsigned long flags
= 0;
276 char *xmit_buf
= NULL
;
279 * Set the TTY IO error marker
282 set_bit(TTY_IO_ERROR
, &tty
->flags
);
284 if (tty_port_initialized(port
)) {
285 tty_port_set_initialized(port
, 0);
288 * Turn off DTR and RTS early.
290 if (uport
&& uart_console(uport
) && tty
)
291 uport
->cons
->cflag
= tty
->termios
.c_cflag
;
293 if (!tty
|| C_HUPCL(tty
))
294 uart_port_dtr_rts(uport
, 0);
296 uart_port_shutdown(port
);
300 * It's possible for shutdown to be called after suspend if we get
301 * a DCD drop (hangup) at just the right time. Clear suspended bit so
302 * we don't try to resume a port that has been shutdown.
304 tty_port_set_suspended(port
, 0);
307 * Do not free() the transmit buffer page under the port lock since
308 * this can create various circular locking scenarios. For instance,
309 * console driver may need to allocate/free a debug object, which
310 * can endup in printk() recursion.
312 uart_port_lock(state
, flags
);
313 xmit_buf
= state
->xmit
.buf
;
314 state
->xmit
.buf
= NULL
;
315 uart_port_unlock(uport
, flags
);
318 free_page((unsigned long)xmit_buf
);
322 * uart_update_timeout - update per-port FIFO timeout.
323 * @port: uart_port structure describing the port
324 * @cflag: termios cflag value
325 * @baud: speed of the port
327 * Set the port FIFO timeout value. The @cflag value should
328 * reflect the actual hardware settings.
331 uart_update_timeout(struct uart_port
*port
, unsigned int cflag
,
336 /* byte size and parity */
337 switch (cflag
& CSIZE
) {
358 * The total number of bits to be transmitted in the fifo.
360 bits
= bits
* port
->fifosize
;
363 * Figure the timeout to send the above number of bits.
364 * Add .02 seconds of slop
366 port
->timeout
= (HZ
* bits
) / baud
+ HZ
/50;
369 EXPORT_SYMBOL(uart_update_timeout
);
372 * uart_get_baud_rate - return baud rate for a particular port
373 * @port: uart_port structure describing the port in question.
374 * @termios: desired termios settings.
375 * @old: old termios (or NULL)
376 * @min: minimum acceptable baud rate
377 * @max: maximum acceptable baud rate
379 * Decode the termios structure into a numeric baud rate,
380 * taking account of the magic 38400 baud rate (with spd_*
381 * flags), and mapping the %B0 rate to 9600 baud.
383 * If the new baud rate is invalid, try the old termios setting.
384 * If it's still invalid, we try 9600 baud.
386 * Update the @termios structure to reflect the baud rate
387 * we're actually going to be using. Don't do this for the case
388 * where B0 is requested ("hang up").
391 uart_get_baud_rate(struct uart_port
*port
, struct ktermios
*termios
,
392 struct ktermios
*old
, unsigned int min
, unsigned int max
)
396 unsigned int altbaud
;
398 upf_t flags
= port
->flags
& UPF_SPD_MASK
;
418 for (try = 0; try < 2; try++) {
419 baud
= tty_termios_baud_rate(termios
);
422 * The spd_hi, spd_vhi, spd_shi, spd_warp kludge...
425 if (try == 0 && baud
== 38400)
429 * Special case: B0 rate.
436 if (baud
>= min
&& baud
<= max
)
440 * Oops, the quotient was zero. Try again with
441 * the old baud rate if possible.
443 termios
->c_cflag
&= ~CBAUD
;
445 baud
= tty_termios_baud_rate(old
);
447 tty_termios_encode_baud_rate(termios
,
454 * As a last resort, if the range cannot be met then clip to
455 * the nearest chip supported rate.
459 tty_termios_encode_baud_rate(termios
,
462 tty_termios_encode_baud_rate(termios
,
466 /* Should never happen */
471 EXPORT_SYMBOL(uart_get_baud_rate
);
474 * uart_get_divisor - return uart clock divisor
475 * @port: uart_port structure describing the port.
476 * @baud: desired baud rate
478 * Calculate the uart clock divisor for the port.
481 uart_get_divisor(struct uart_port
*port
, unsigned int baud
)
486 * Old custom speed handling.
488 if (baud
== 38400 && (port
->flags
& UPF_SPD_MASK
) == UPF_SPD_CUST
)
489 quot
= port
->custom_divisor
;
491 quot
= DIV_ROUND_CLOSEST(port
->uartclk
, 16 * baud
);
496 EXPORT_SYMBOL(uart_get_divisor
);
498 /* Caller holds port mutex */
499 static void uart_change_speed(struct tty_struct
*tty
, struct uart_state
*state
,
500 struct ktermios
*old_termios
)
502 struct uart_port
*uport
= uart_port_check(state
);
503 struct ktermios
*termios
;
507 * If we have no tty, termios, or the port does not exist,
508 * then we can't set the parameters for this port.
510 if (!tty
|| uport
->type
== PORT_UNKNOWN
)
513 termios
= &tty
->termios
;
514 uport
->ops
->set_termios(uport
, termios
, old_termios
);
517 * Set modem status enables based on termios cflag
519 spin_lock_irq(&uport
->lock
);
520 if (termios
->c_cflag
& CRTSCTS
)
521 uport
->status
|= UPSTAT_CTS_ENABLE
;
523 uport
->status
&= ~UPSTAT_CTS_ENABLE
;
525 if (termios
->c_cflag
& CLOCAL
)
526 uport
->status
&= ~UPSTAT_DCD_ENABLE
;
528 uport
->status
|= UPSTAT_DCD_ENABLE
;
530 /* reset sw-assisted CTS flow control based on (possibly) new mode */
531 hw_stopped
= uport
->hw_stopped
;
532 uport
->hw_stopped
= uart_softcts_mode(uport
) &&
533 !(uport
->ops
->get_mctrl(uport
) & TIOCM_CTS
);
534 if (uport
->hw_stopped
) {
536 uport
->ops
->stop_tx(uport
);
541 spin_unlock_irq(&uport
->lock
);
544 static int uart_put_char(struct tty_struct
*tty
, unsigned char c
)
546 struct uart_state
*state
= tty
->driver_data
;
547 struct uart_port
*port
;
548 struct circ_buf
*circ
;
553 port
= uart_port_lock(state
, flags
);
555 uart_port_unlock(port
, flags
);
559 if (port
&& uart_circ_chars_free(circ
) != 0) {
560 circ
->buf
[circ
->head
] = c
;
561 circ
->head
= (circ
->head
+ 1) & (UART_XMIT_SIZE
- 1);
564 uart_port_unlock(port
, flags
);
568 static void uart_flush_chars(struct tty_struct
*tty
)
573 static int uart_write(struct tty_struct
*tty
,
574 const unsigned char *buf
, int count
)
576 struct uart_state
*state
= tty
->driver_data
;
577 struct uart_port
*port
;
578 struct circ_buf
*circ
;
583 * This means you called this function _after_ the port was
584 * closed. No cookie for you.
591 port
= uart_port_lock(state
, flags
);
594 uart_port_unlock(port
, flags
);
599 c
= CIRC_SPACE_TO_END(circ
->head
, circ
->tail
, UART_XMIT_SIZE
);
604 memcpy(circ
->buf
+ circ
->head
, buf
, c
);
605 circ
->head
= (circ
->head
+ c
) & (UART_XMIT_SIZE
- 1);
612 uart_port_unlock(port
, flags
);
616 static int uart_write_room(struct tty_struct
*tty
)
618 struct uart_state
*state
= tty
->driver_data
;
619 struct uart_port
*port
;
623 port
= uart_port_lock(state
, flags
);
624 ret
= uart_circ_chars_free(&state
->xmit
);
625 uart_port_unlock(port
, flags
);
629 static int uart_chars_in_buffer(struct tty_struct
*tty
)
631 struct uart_state
*state
= tty
->driver_data
;
632 struct uart_port
*port
;
636 port
= uart_port_lock(state
, flags
);
637 ret
= uart_circ_chars_pending(&state
->xmit
);
638 uart_port_unlock(port
, flags
);
642 static void uart_flush_buffer(struct tty_struct
*tty
)
644 struct uart_state
*state
= tty
->driver_data
;
645 struct uart_port
*port
;
649 * This means you called this function _after_ the port was
650 * closed. No cookie for you.
657 pr_debug("uart_flush_buffer(%d) called\n", tty
->index
);
659 port
= uart_port_lock(state
, flags
);
662 uart_circ_clear(&state
->xmit
);
663 if (port
->ops
->flush_buffer
)
664 port
->ops
->flush_buffer(port
);
665 uart_port_unlock(port
, flags
);
666 tty_port_tty_wakeup(&state
->port
);
670 * This function is used to send a high-priority XON/XOFF character to
673 static void uart_send_xchar(struct tty_struct
*tty
, char ch
)
675 struct uart_state
*state
= tty
->driver_data
;
676 struct uart_port
*port
;
679 port
= uart_port_ref(state
);
683 if (port
->ops
->send_xchar
)
684 port
->ops
->send_xchar(port
, ch
);
686 spin_lock_irqsave(&port
->lock
, flags
);
689 port
->ops
->start_tx(port
);
690 spin_unlock_irqrestore(&port
->lock
, flags
);
692 uart_port_deref(port
);
695 static void uart_throttle(struct tty_struct
*tty
)
697 struct uart_state
*state
= tty
->driver_data
;
698 upstat_t mask
= UPSTAT_SYNC_FIFO
;
699 struct uart_port
*port
;
701 port
= uart_port_ref(state
);
706 mask
|= UPSTAT_AUTOXOFF
;
708 mask
|= UPSTAT_AUTORTS
;
710 if (port
->status
& mask
) {
711 port
->ops
->throttle(port
);
712 mask
&= ~port
->status
;
715 if (mask
& UPSTAT_AUTORTS
)
716 uart_clear_mctrl(port
, TIOCM_RTS
);
718 if (mask
& UPSTAT_AUTOXOFF
)
719 uart_send_xchar(tty
, STOP_CHAR(tty
));
721 uart_port_deref(port
);
724 static void uart_unthrottle(struct tty_struct
*tty
)
726 struct uart_state
*state
= tty
->driver_data
;
727 upstat_t mask
= UPSTAT_SYNC_FIFO
;
728 struct uart_port
*port
;
730 port
= uart_port_ref(state
);
735 mask
|= UPSTAT_AUTOXOFF
;
737 mask
|= UPSTAT_AUTORTS
;
739 if (port
->status
& mask
) {
740 port
->ops
->unthrottle(port
);
741 mask
&= ~port
->status
;
744 if (mask
& UPSTAT_AUTORTS
)
745 uart_set_mctrl(port
, TIOCM_RTS
);
747 if (mask
& UPSTAT_AUTOXOFF
)
748 uart_send_xchar(tty
, START_CHAR(tty
));
750 uart_port_deref(port
);
753 static int uart_get_info(struct tty_port
*port
, struct serial_struct
*retinfo
)
755 struct uart_state
*state
= container_of(port
, struct uart_state
, port
);
756 struct uart_port
*uport
;
759 memset(retinfo
, 0, sizeof(*retinfo
));
762 * Ensure the state we copy is consistent and no hardware changes
765 mutex_lock(&port
->mutex
);
766 uport
= uart_port_check(state
);
770 retinfo
->type
= uport
->type
;
771 retinfo
->line
= uport
->line
;
772 retinfo
->port
= uport
->iobase
;
773 if (HIGH_BITS_OFFSET
)
774 retinfo
->port_high
= (long) uport
->iobase
>> HIGH_BITS_OFFSET
;
775 retinfo
->irq
= uport
->irq
;
776 retinfo
->flags
= (__force
int)uport
->flags
;
777 retinfo
->xmit_fifo_size
= uport
->fifosize
;
778 retinfo
->baud_base
= uport
->uartclk
/ 16;
779 retinfo
->close_delay
= jiffies_to_msecs(port
->close_delay
) / 10;
780 retinfo
->closing_wait
= port
->closing_wait
== ASYNC_CLOSING_WAIT_NONE
?
781 ASYNC_CLOSING_WAIT_NONE
:
782 jiffies_to_msecs(port
->closing_wait
) / 10;
783 retinfo
->custom_divisor
= uport
->custom_divisor
;
784 retinfo
->hub6
= uport
->hub6
;
785 retinfo
->io_type
= uport
->iotype
;
786 retinfo
->iomem_reg_shift
= uport
->regshift
;
787 retinfo
->iomem_base
= (void *)(unsigned long)uport
->mapbase
;
791 mutex_unlock(&port
->mutex
);
795 static int uart_get_info_user(struct tty_struct
*tty
,
796 struct serial_struct
*ss
)
798 struct uart_state
*state
= tty
->driver_data
;
799 struct tty_port
*port
= &state
->port
;
801 return uart_get_info(port
, ss
) < 0 ? -EIO
: 0;
804 static int uart_set_info(struct tty_struct
*tty
, struct tty_port
*port
,
805 struct uart_state
*state
,
806 struct serial_struct
*new_info
)
808 struct uart_port
*uport
= uart_port_check(state
);
809 unsigned long new_port
;
810 unsigned int change_irq
, change_port
, closing_wait
;
811 unsigned int old_custom_divisor
, close_delay
;
812 upf_t old_flags
, new_flags
;
818 new_port
= new_info
->port
;
819 if (HIGH_BITS_OFFSET
)
820 new_port
+= (unsigned long) new_info
->port_high
<< HIGH_BITS_OFFSET
;
822 new_info
->irq
= irq_canonicalize(new_info
->irq
);
823 close_delay
= msecs_to_jiffies(new_info
->close_delay
* 10);
824 closing_wait
= new_info
->closing_wait
== ASYNC_CLOSING_WAIT_NONE
?
825 ASYNC_CLOSING_WAIT_NONE
:
826 msecs_to_jiffies(new_info
->closing_wait
* 10);
829 change_irq
= !(uport
->flags
& UPF_FIXED_PORT
)
830 && new_info
->irq
!= uport
->irq
;
833 * Since changing the 'type' of the port changes its resource
834 * allocations, we should treat type changes the same as
837 change_port
= !(uport
->flags
& UPF_FIXED_PORT
)
838 && (new_port
!= uport
->iobase
||
839 (unsigned long)new_info
->iomem_base
!= uport
->mapbase
||
840 new_info
->hub6
!= uport
->hub6
||
841 new_info
->io_type
!= uport
->iotype
||
842 new_info
->iomem_reg_shift
!= uport
->regshift
||
843 new_info
->type
!= uport
->type
);
845 old_flags
= uport
->flags
;
846 new_flags
= (__force upf_t
)new_info
->flags
;
847 old_custom_divisor
= uport
->custom_divisor
;
849 if (!capable(CAP_SYS_ADMIN
)) {
851 if (change_irq
|| change_port
||
852 (new_info
->baud_base
!= uport
->uartclk
/ 16) ||
853 (close_delay
!= port
->close_delay
) ||
854 (closing_wait
!= port
->closing_wait
) ||
855 (new_info
->xmit_fifo_size
&&
856 new_info
->xmit_fifo_size
!= uport
->fifosize
) ||
857 (((new_flags
^ old_flags
) & ~UPF_USR_MASK
) != 0))
859 uport
->flags
= ((uport
->flags
& ~UPF_USR_MASK
) |
860 (new_flags
& UPF_USR_MASK
));
861 uport
->custom_divisor
= new_info
->custom_divisor
;
866 * Ask the low level driver to verify the settings.
868 if (uport
->ops
->verify_port
)
869 retval
= uport
->ops
->verify_port(uport
, new_info
);
871 if ((new_info
->irq
>= nr_irqs
) || (new_info
->irq
< 0) ||
872 (new_info
->baud_base
< 9600))
878 if (change_port
|| change_irq
) {
882 * Make sure that we are the sole user of this port.
884 if (tty_port_users(port
) > 1)
888 * We need to shutdown the serial port at the old
889 * port/type/irq combination.
891 uart_shutdown(tty
, state
);
895 unsigned long old_iobase
, old_mapbase
;
896 unsigned int old_type
, old_iotype
, old_hub6
, old_shift
;
898 old_iobase
= uport
->iobase
;
899 old_mapbase
= uport
->mapbase
;
900 old_type
= uport
->type
;
901 old_hub6
= uport
->hub6
;
902 old_iotype
= uport
->iotype
;
903 old_shift
= uport
->regshift
;
906 * Free and release old regions
908 if (old_type
!= PORT_UNKNOWN
&& uport
->ops
->release_port
)
909 uport
->ops
->release_port(uport
);
911 uport
->iobase
= new_port
;
912 uport
->type
= new_info
->type
;
913 uport
->hub6
= new_info
->hub6
;
914 uport
->iotype
= new_info
->io_type
;
915 uport
->regshift
= new_info
->iomem_reg_shift
;
916 uport
->mapbase
= (unsigned long)new_info
->iomem_base
;
919 * Claim and map the new regions
921 if (uport
->type
!= PORT_UNKNOWN
&& uport
->ops
->request_port
) {
922 retval
= uport
->ops
->request_port(uport
);
924 /* Always success - Jean II */
929 * If we fail to request resources for the
930 * new port, try to restore the old settings.
933 uport
->iobase
= old_iobase
;
934 uport
->type
= old_type
;
935 uport
->hub6
= old_hub6
;
936 uport
->iotype
= old_iotype
;
937 uport
->regshift
= old_shift
;
938 uport
->mapbase
= old_mapbase
;
940 if (old_type
!= PORT_UNKNOWN
) {
941 retval
= uport
->ops
->request_port(uport
);
943 * If we failed to restore the old settings,
947 uport
->type
= PORT_UNKNOWN
;
955 /* Added to return the correct error -Ram Gupta */
961 uport
->irq
= new_info
->irq
;
962 if (!(uport
->flags
& UPF_FIXED_PORT
))
963 uport
->uartclk
= new_info
->baud_base
* 16;
964 uport
->flags
= (uport
->flags
& ~UPF_CHANGE_MASK
) |
965 (new_flags
& UPF_CHANGE_MASK
);
966 uport
->custom_divisor
= new_info
->custom_divisor
;
967 port
->close_delay
= close_delay
;
968 port
->closing_wait
= closing_wait
;
969 if (new_info
->xmit_fifo_size
)
970 uport
->fifosize
= new_info
->xmit_fifo_size
;
971 port
->low_latency
= (uport
->flags
& UPF_LOW_LATENCY
) ? 1 : 0;
975 if (uport
->type
== PORT_UNKNOWN
)
977 if (tty_port_initialized(port
)) {
978 if (((old_flags
^ uport
->flags
) & UPF_SPD_MASK
) ||
979 old_custom_divisor
!= uport
->custom_divisor
) {
981 * If they're setting up a custom divisor or speed,
982 * instead of clearing it, then bitch about it.
984 if (uport
->flags
& UPF_SPD_MASK
) {
985 dev_notice_ratelimited(uport
->dev
,
986 "%s sets custom speed on %s. This is deprecated.\n",
988 tty_name(port
->tty
));
990 uart_change_speed(tty
, state
, NULL
);
993 retval
= uart_startup(tty
, state
, 1);
995 tty_port_set_initialized(port
, true);
1003 static int uart_set_info_user(struct tty_struct
*tty
, struct serial_struct
*ss
)
1005 struct uart_state
*state
= tty
->driver_data
;
1006 struct tty_port
*port
= &state
->port
;
1009 down_write(&tty
->termios_rwsem
);
1011 * This semaphore protects port->count. It is also
1012 * very useful to prevent opens. Also, take the
1013 * port configuration semaphore to make sure that a
1014 * module insertion/removal doesn't change anything
1017 mutex_lock(&port
->mutex
);
1018 retval
= uart_set_info(tty
, port
, state
, ss
);
1019 mutex_unlock(&port
->mutex
);
1020 up_write(&tty
->termios_rwsem
);
1025 * uart_get_lsr_info - get line status register info
1026 * @tty: tty associated with the UART
1027 * @state: UART being queried
1028 * @value: returned modem value
1030 static int uart_get_lsr_info(struct tty_struct
*tty
,
1031 struct uart_state
*state
, unsigned int __user
*value
)
1033 struct uart_port
*uport
= uart_port_check(state
);
1034 unsigned int result
;
1036 result
= uport
->ops
->tx_empty(uport
);
1039 * If we're about to load something into the transmit
1040 * register, we'll pretend the transmitter isn't empty to
1041 * avoid a race condition (depending on when the transmit
1042 * interrupt happens).
1044 if (uport
->x_char
||
1045 ((uart_circ_chars_pending(&state
->xmit
) > 0) &&
1046 !uart_tx_stopped(uport
)))
1047 result
&= ~TIOCSER_TEMT
;
1049 return put_user(result
, value
);
1052 static int uart_tiocmget(struct tty_struct
*tty
)
1054 struct uart_state
*state
= tty
->driver_data
;
1055 struct tty_port
*port
= &state
->port
;
1056 struct uart_port
*uport
;
1059 mutex_lock(&port
->mutex
);
1060 uport
= uart_port_check(state
);
1064 if (!tty_io_error(tty
)) {
1065 result
= uport
->mctrl
;
1066 spin_lock_irq(&uport
->lock
);
1067 result
|= uport
->ops
->get_mctrl(uport
);
1068 spin_unlock_irq(&uport
->lock
);
1071 mutex_unlock(&port
->mutex
);
1076 uart_tiocmset(struct tty_struct
*tty
, unsigned int set
, unsigned int clear
)
1078 struct uart_state
*state
= tty
->driver_data
;
1079 struct tty_port
*port
= &state
->port
;
1080 struct uart_port
*uport
;
1083 mutex_lock(&port
->mutex
);
1084 uport
= uart_port_check(state
);
1088 if (!tty_io_error(tty
)) {
1089 uart_update_mctrl(uport
, set
, clear
);
1093 mutex_unlock(&port
->mutex
);
1097 static int uart_break_ctl(struct tty_struct
*tty
, int break_state
)
1099 struct uart_state
*state
= tty
->driver_data
;
1100 struct tty_port
*port
= &state
->port
;
1101 struct uart_port
*uport
;
1104 mutex_lock(&port
->mutex
);
1105 uport
= uart_port_check(state
);
1109 if (uport
->type
!= PORT_UNKNOWN
)
1110 uport
->ops
->break_ctl(uport
, break_state
);
1113 mutex_unlock(&port
->mutex
);
1117 static int uart_do_autoconfig(struct tty_struct
*tty
,struct uart_state
*state
)
1119 struct tty_port
*port
= &state
->port
;
1120 struct uart_port
*uport
;
1123 if (!capable(CAP_SYS_ADMIN
))
1127 * Take the per-port semaphore. This prevents count from
1128 * changing, and hence any extra opens of the port while
1129 * we're auto-configuring.
1131 if (mutex_lock_interruptible(&port
->mutex
))
1132 return -ERESTARTSYS
;
1134 uport
= uart_port_check(state
);
1141 if (tty_port_users(port
) == 1) {
1142 uart_shutdown(tty
, state
);
1145 * If we already have a port type configured,
1146 * we must release its resources.
1148 if (uport
->type
!= PORT_UNKNOWN
&& uport
->ops
->release_port
)
1149 uport
->ops
->release_port(uport
);
1151 flags
= UART_CONFIG_TYPE
;
1152 if (uport
->flags
& UPF_AUTO_IRQ
)
1153 flags
|= UART_CONFIG_IRQ
;
1156 * This will claim the ports resources if
1159 uport
->ops
->config_port(uport
, flags
);
1161 ret
= uart_startup(tty
, state
, 1);
1163 tty_port_set_initialized(port
, true);
1168 mutex_unlock(&port
->mutex
);
1172 static void uart_enable_ms(struct uart_port
*uport
)
1175 * Force modem status interrupts on
1177 if (uport
->ops
->enable_ms
)
1178 uport
->ops
->enable_ms(uport
);
1182 * Wait for any of the 4 modem inputs (DCD,RI,DSR,CTS) to change
1183 * - mask passed in arg for lines of interest
1184 * (use |'ed TIOCM_RNG/DSR/CD/CTS for masking)
1185 * Caller should use TIOCGICOUNT to see which one it was
1187 * FIXME: This wants extracting into a common all driver implementation
1188 * of TIOCMWAIT using tty_port.
1190 static int uart_wait_modem_status(struct uart_state
*state
, unsigned long arg
)
1192 struct uart_port
*uport
;
1193 struct tty_port
*port
= &state
->port
;
1194 DECLARE_WAITQUEUE(wait
, current
);
1195 struct uart_icount cprev
, cnow
;
1199 * note the counters on entry
1201 uport
= uart_port_ref(state
);
1204 spin_lock_irq(&uport
->lock
);
1205 memcpy(&cprev
, &uport
->icount
, sizeof(struct uart_icount
));
1206 uart_enable_ms(uport
);
1207 spin_unlock_irq(&uport
->lock
);
1209 add_wait_queue(&port
->delta_msr_wait
, &wait
);
1211 spin_lock_irq(&uport
->lock
);
1212 memcpy(&cnow
, &uport
->icount
, sizeof(struct uart_icount
));
1213 spin_unlock_irq(&uport
->lock
);
1215 set_current_state(TASK_INTERRUPTIBLE
);
1217 if (((arg
& TIOCM_RNG
) && (cnow
.rng
!= cprev
.rng
)) ||
1218 ((arg
& TIOCM_DSR
) && (cnow
.dsr
!= cprev
.dsr
)) ||
1219 ((arg
& TIOCM_CD
) && (cnow
.dcd
!= cprev
.dcd
)) ||
1220 ((arg
& TIOCM_CTS
) && (cnow
.cts
!= cprev
.cts
))) {
1227 /* see if a signal did it */
1228 if (signal_pending(current
)) {
1235 __set_current_state(TASK_RUNNING
);
1236 remove_wait_queue(&port
->delta_msr_wait
, &wait
);
1237 uart_port_deref(uport
);
1243 * Get counter of input serial line interrupts (DCD,RI,DSR,CTS)
1244 * Return: write counters to the user passed counter struct
1245 * NB: both 1->0 and 0->1 transitions are counted except for
1246 * RI where only 0->1 is counted.
1248 static int uart_get_icount(struct tty_struct
*tty
,
1249 struct serial_icounter_struct
*icount
)
1251 struct uart_state
*state
= tty
->driver_data
;
1252 struct uart_icount cnow
;
1253 struct uart_port
*uport
;
1255 uport
= uart_port_ref(state
);
1258 spin_lock_irq(&uport
->lock
);
1259 memcpy(&cnow
, &uport
->icount
, sizeof(struct uart_icount
));
1260 spin_unlock_irq(&uport
->lock
);
1261 uart_port_deref(uport
);
1263 icount
->cts
= cnow
.cts
;
1264 icount
->dsr
= cnow
.dsr
;
1265 icount
->rng
= cnow
.rng
;
1266 icount
->dcd
= cnow
.dcd
;
1267 icount
->rx
= cnow
.rx
;
1268 icount
->tx
= cnow
.tx
;
1269 icount
->frame
= cnow
.frame
;
1270 icount
->overrun
= cnow
.overrun
;
1271 icount
->parity
= cnow
.parity
;
1272 icount
->brk
= cnow
.brk
;
1273 icount
->buf_overrun
= cnow
.buf_overrun
;
1278 static int uart_get_rs485_config(struct uart_port
*port
,
1279 struct serial_rs485 __user
*rs485
)
1281 unsigned long flags
;
1282 struct serial_rs485 aux
;
1284 spin_lock_irqsave(&port
->lock
, flags
);
1286 spin_unlock_irqrestore(&port
->lock
, flags
);
1288 if (copy_to_user(rs485
, &aux
, sizeof(aux
)))
1294 static int uart_set_rs485_config(struct uart_port
*port
,
1295 struct serial_rs485 __user
*rs485_user
)
1297 struct serial_rs485 rs485
;
1299 unsigned long flags
;
1301 if (!port
->rs485_config
)
1302 return -ENOIOCTLCMD
;
1304 if (copy_from_user(&rs485
, rs485_user
, sizeof(*rs485_user
)))
1307 spin_lock_irqsave(&port
->lock
, flags
);
1308 ret
= port
->rs485_config(port
, &rs485
);
1309 spin_unlock_irqrestore(&port
->lock
, flags
);
1313 if (copy_to_user(rs485_user
, &port
->rs485
, sizeof(port
->rs485
)))
1319 static int uart_get_iso7816_config(struct uart_port
*port
,
1320 struct serial_iso7816 __user
*iso7816
)
1322 unsigned long flags
;
1323 struct serial_iso7816 aux
;
1325 if (!port
->iso7816_config
)
1326 return -ENOIOCTLCMD
;
1328 spin_lock_irqsave(&port
->lock
, flags
);
1329 aux
= port
->iso7816
;
1330 spin_unlock_irqrestore(&port
->lock
, flags
);
1332 if (copy_to_user(iso7816
, &aux
, sizeof(aux
)))
1338 static int uart_set_iso7816_config(struct uart_port
*port
,
1339 struct serial_iso7816 __user
*iso7816_user
)
1341 struct serial_iso7816 iso7816
;
1343 unsigned long flags
;
1345 if (!port
->iso7816_config
)
1346 return -ENOIOCTLCMD
;
1348 if (copy_from_user(&iso7816
, iso7816_user
, sizeof(*iso7816_user
)))
1352 * There are 5 words reserved for future use. Check that userspace
1353 * doesn't put stuff in there to prevent breakages in the future.
1355 for (i
= 0; i
< 5; i
++)
1356 if (iso7816
.reserved
[i
])
1359 spin_lock_irqsave(&port
->lock
, flags
);
1360 ret
= port
->iso7816_config(port
, &iso7816
);
1361 spin_unlock_irqrestore(&port
->lock
, flags
);
1365 if (copy_to_user(iso7816_user
, &port
->iso7816
, sizeof(port
->iso7816
)))
1372 * Called via sys_ioctl. We can use spin_lock_irq() here.
1375 uart_ioctl(struct tty_struct
*tty
, unsigned int cmd
, unsigned long arg
)
1377 struct uart_state
*state
= tty
->driver_data
;
1378 struct tty_port
*port
= &state
->port
;
1379 struct uart_port
*uport
;
1380 void __user
*uarg
= (void __user
*)arg
;
1381 int ret
= -ENOIOCTLCMD
;
1385 * These ioctls don't rely on the hardware to be present.
1389 down_write(&tty
->termios_rwsem
);
1390 ret
= uart_do_autoconfig(tty
, state
);
1391 up_write(&tty
->termios_rwsem
);
1395 if (ret
!= -ENOIOCTLCMD
)
1398 if (tty_io_error(tty
)) {
1404 * The following should only be used when hardware is present.
1408 ret
= uart_wait_modem_status(state
, arg
);
1412 if (ret
!= -ENOIOCTLCMD
)
1415 mutex_lock(&port
->mutex
);
1416 uport
= uart_port_check(state
);
1418 if (!uport
|| tty_io_error(tty
)) {
1424 * All these rely on hardware being present and need to be
1425 * protected against the tty being hung up.
1429 case TIOCSERGETLSR
: /* Get line status register */
1430 ret
= uart_get_lsr_info(tty
, state
, uarg
);
1434 ret
= uart_get_rs485_config(uport
, uarg
);
1438 ret
= uart_set_rs485_config(uport
, uarg
);
1442 ret
= uart_set_iso7816_config(state
->uart_port
, uarg
);
1446 ret
= uart_get_iso7816_config(state
->uart_port
, uarg
);
1449 if (uport
->ops
->ioctl
)
1450 ret
= uport
->ops
->ioctl(uport
, cmd
, arg
);
1454 mutex_unlock(&port
->mutex
);
1459 static void uart_set_ldisc(struct tty_struct
*tty
)
1461 struct uart_state
*state
= tty
->driver_data
;
1462 struct uart_port
*uport
;
1464 mutex_lock(&state
->port
.mutex
);
1465 uport
= uart_port_check(state
);
1466 if (uport
&& uport
->ops
->set_ldisc
)
1467 uport
->ops
->set_ldisc(uport
, &tty
->termios
);
1468 mutex_unlock(&state
->port
.mutex
);
1471 static void uart_set_termios(struct tty_struct
*tty
,
1472 struct ktermios
*old_termios
)
1474 struct uart_state
*state
= tty
->driver_data
;
1475 struct uart_port
*uport
;
1476 unsigned int cflag
= tty
->termios
.c_cflag
;
1477 unsigned int iflag_mask
= IGNBRK
|BRKINT
|IGNPAR
|PARMRK
|INPCK
;
1478 bool sw_changed
= false;
1480 mutex_lock(&state
->port
.mutex
);
1481 uport
= uart_port_check(state
);
1486 * Drivers doing software flow control also need to know
1487 * about changes to these input settings.
1489 if (uport
->flags
& UPF_SOFT_FLOW
) {
1490 iflag_mask
|= IXANY
|IXON
|IXOFF
;
1492 tty
->termios
.c_cc
[VSTART
] != old_termios
->c_cc
[VSTART
] ||
1493 tty
->termios
.c_cc
[VSTOP
] != old_termios
->c_cc
[VSTOP
];
1497 * These are the bits that are used to setup various
1498 * flags in the low level driver. We can ignore the Bfoo
1499 * bits in c_cflag; c_[io]speed will always be set
1500 * appropriately by set_termios() in tty_ioctl.c
1502 if ((cflag
^ old_termios
->c_cflag
) == 0 &&
1503 tty
->termios
.c_ospeed
== old_termios
->c_ospeed
&&
1504 tty
->termios
.c_ispeed
== old_termios
->c_ispeed
&&
1505 ((tty
->termios
.c_iflag
^ old_termios
->c_iflag
) & iflag_mask
) == 0 &&
1510 uart_change_speed(tty
, state
, old_termios
);
1511 /* reload cflag from termios; port driver may have overridden flags */
1512 cflag
= tty
->termios
.c_cflag
;
1514 /* Handle transition to B0 status */
1515 if ((old_termios
->c_cflag
& CBAUD
) && !(cflag
& CBAUD
))
1516 uart_clear_mctrl(uport
, TIOCM_RTS
| TIOCM_DTR
);
1517 /* Handle transition away from B0 status */
1518 else if (!(old_termios
->c_cflag
& CBAUD
) && (cflag
& CBAUD
)) {
1519 unsigned int mask
= TIOCM_DTR
;
1520 if (!(cflag
& CRTSCTS
) || !tty_throttled(tty
))
1522 uart_set_mctrl(uport
, mask
);
1525 mutex_unlock(&state
->port
.mutex
);
1529 * Calls to uart_close() are serialised via the tty_lock in
1530 * drivers/tty/tty_io.c:tty_release()
1531 * drivers/tty/tty_io.c:do_tty_hangup()
1533 static void uart_close(struct tty_struct
*tty
, struct file
*filp
)
1535 struct uart_state
*state
= tty
->driver_data
;
1538 struct uart_driver
*drv
= tty
->driver
->driver_state
;
1539 struct tty_port
*port
;
1541 state
= drv
->state
+ tty
->index
;
1542 port
= &state
->port
;
1543 spin_lock_irq(&port
->lock
);
1545 spin_unlock_irq(&port
->lock
);
1549 pr_debug("uart_close(%d) called\n", tty
->index
);
1551 tty_port_close(tty
->port
, tty
, filp
);
1554 static void uart_tty_port_shutdown(struct tty_port
*port
)
1556 struct uart_state
*state
= container_of(port
, struct uart_state
, port
);
1557 struct uart_port
*uport
= uart_port_check(state
);
1560 * At this point, we stop accepting input. To do this, we
1561 * disable the receive line status interrupts.
1563 if (WARN(!uport
, "detached port still initialized!\n"))
1566 spin_lock_irq(&uport
->lock
);
1567 uport
->ops
->stop_rx(uport
);
1568 spin_unlock_irq(&uport
->lock
);
1570 uart_port_shutdown(port
);
1573 * It's possible for shutdown to be called after suspend if we get
1574 * a DCD drop (hangup) at just the right time. Clear suspended bit so
1575 * we don't try to resume a port that has been shutdown.
1577 tty_port_set_suspended(port
, 0);
1579 uart_change_pm(state
, UART_PM_STATE_OFF
);
1583 static void uart_wait_until_sent(struct tty_struct
*tty
, int timeout
)
1585 struct uart_state
*state
= tty
->driver_data
;
1586 struct uart_port
*port
;
1587 unsigned long char_time
, expire
;
1589 port
= uart_port_ref(state
);
1593 if (port
->type
== PORT_UNKNOWN
|| port
->fifosize
== 0) {
1594 uart_port_deref(port
);
1599 * Set the check interval to be 1/5 of the estimated time to
1600 * send a single character, and make it at least 1. The check
1601 * interval should also be less than the timeout.
1603 * Note: we have to use pretty tight timings here to satisfy
1606 char_time
= (port
->timeout
- HZ
/50) / port
->fifosize
;
1607 char_time
= char_time
/ 5;
1610 if (timeout
&& timeout
< char_time
)
1611 char_time
= timeout
;
1614 * If the transmitter hasn't cleared in twice the approximate
1615 * amount of time to send the entire FIFO, it probably won't
1616 * ever clear. This assumes the UART isn't doing flow
1617 * control, which is currently the case. Hence, if it ever
1618 * takes longer than port->timeout, this is probably due to a
1619 * UART bug of some kind. So, we clamp the timeout parameter at
1622 if (timeout
== 0 || timeout
> 2 * port
->timeout
)
1623 timeout
= 2 * port
->timeout
;
1625 expire
= jiffies
+ timeout
;
1627 pr_debug("uart_wait_until_sent(%d), jiffies=%lu, expire=%lu...\n",
1628 port
->line
, jiffies
, expire
);
1631 * Check whether the transmitter is empty every 'char_time'.
1632 * 'timeout' / 'expire' give us the maximum amount of time
1635 while (!port
->ops
->tx_empty(port
)) {
1636 msleep_interruptible(jiffies_to_msecs(char_time
));
1637 if (signal_pending(current
))
1639 if (time_after(jiffies
, expire
))
1642 uart_port_deref(port
);
1646 * Calls to uart_hangup() are serialised by the tty_lock in
1647 * drivers/tty/tty_io.c:do_tty_hangup()
1648 * This runs from a workqueue and can sleep for a _short_ time only.
1650 static void uart_hangup(struct tty_struct
*tty
)
1652 struct uart_state
*state
= tty
->driver_data
;
1653 struct tty_port
*port
= &state
->port
;
1654 struct uart_port
*uport
;
1655 unsigned long flags
;
1657 pr_debug("uart_hangup(%d)\n", tty
->index
);
1659 mutex_lock(&port
->mutex
);
1660 uport
= uart_port_check(state
);
1661 WARN(!uport
, "hangup of detached port!\n");
1663 if (tty_port_active(port
)) {
1664 uart_flush_buffer(tty
);
1665 uart_shutdown(tty
, state
);
1666 spin_lock_irqsave(&port
->lock
, flags
);
1668 spin_unlock_irqrestore(&port
->lock
, flags
);
1669 tty_port_set_active(port
, 0);
1670 tty_port_tty_set(port
, NULL
);
1671 if (uport
&& !uart_console(uport
))
1672 uart_change_pm(state
, UART_PM_STATE_OFF
);
1673 wake_up_interruptible(&port
->open_wait
);
1674 wake_up_interruptible(&port
->delta_msr_wait
);
1676 mutex_unlock(&port
->mutex
);
1679 /* uport == NULL if uart_port has already been removed */
1680 static void uart_port_shutdown(struct tty_port
*port
)
1682 struct uart_state
*state
= container_of(port
, struct uart_state
, port
);
1683 struct uart_port
*uport
= uart_port_check(state
);
1686 * clear delta_msr_wait queue to avoid mem leaks: we may free
1687 * the irq here so the queue might never be woken up. Note
1688 * that we won't end up waiting on delta_msr_wait again since
1689 * any outstanding file descriptors should be pointing at
1690 * hung_up_tty_fops now.
1692 wake_up_interruptible(&port
->delta_msr_wait
);
1695 * Free the IRQ and disable the port.
1698 uport
->ops
->shutdown(uport
);
1701 * Ensure that the IRQ handler isn't running on another CPU.
1704 synchronize_irq(uport
->irq
);
1707 static int uart_carrier_raised(struct tty_port
*port
)
1709 struct uart_state
*state
= container_of(port
, struct uart_state
, port
);
1710 struct uart_port
*uport
;
1713 uport
= uart_port_ref(state
);
1715 * Should never observe uport == NULL since checks for hangup should
1716 * abort the tty_port_block_til_ready() loop before checking for carrier
1717 * raised -- but report carrier raised if it does anyway so open will
1718 * continue and not sleep
1720 if (WARN_ON(!uport
))
1722 spin_lock_irq(&uport
->lock
);
1723 uart_enable_ms(uport
);
1724 mctrl
= uport
->ops
->get_mctrl(uport
);
1725 spin_unlock_irq(&uport
->lock
);
1726 uart_port_deref(uport
);
1727 if (mctrl
& TIOCM_CAR
)
1732 static void uart_dtr_rts(struct tty_port
*port
, int raise
)
1734 struct uart_state
*state
= container_of(port
, struct uart_state
, port
);
1735 struct uart_port
*uport
;
1737 uport
= uart_port_ref(state
);
1740 uart_port_dtr_rts(uport
, raise
);
1741 uart_port_deref(uport
);
1744 static int uart_install(struct tty_driver
*driver
, struct tty_struct
*tty
)
1746 struct uart_driver
*drv
= driver
->driver_state
;
1747 struct uart_state
*state
= drv
->state
+ tty
->index
;
1749 tty
->driver_data
= state
;
1751 return tty_standard_install(driver
, tty
);
1755 * Calls to uart_open are serialised by the tty_lock in
1756 * drivers/tty/tty_io.c:tty_open()
1757 * Note that if this fails, then uart_close() _will_ be called.
1759 * In time, we want to scrap the "opening nonpresent ports"
1760 * behaviour and implement an alternative way for setserial
1761 * to set base addresses/ports/types. This will allow us to
1762 * get rid of a certain amount of extra tests.
1764 static int uart_open(struct tty_struct
*tty
, struct file
*filp
)
1766 struct uart_state
*state
= tty
->driver_data
;
1769 retval
= tty_port_open(&state
->port
, tty
, filp
);
1776 static int uart_port_activate(struct tty_port
*port
, struct tty_struct
*tty
)
1778 struct uart_state
*state
= container_of(port
, struct uart_state
, port
);
1779 struct uart_port
*uport
;
1781 uport
= uart_port_check(state
);
1782 if (!uport
|| uport
->flags
& UPF_DEAD
)
1785 port
->low_latency
= (uport
->flags
& UPF_LOW_LATENCY
) ? 1 : 0;
1788 * Start up the serial port.
1790 return uart_startup(tty
, state
, 0);
1793 static const char *uart_type(struct uart_port
*port
)
1795 const char *str
= NULL
;
1797 if (port
->ops
->type
)
1798 str
= port
->ops
->type(port
);
1806 #ifdef CONFIG_PROC_FS
1808 static void uart_line_info(struct seq_file
*m
, struct uart_driver
*drv
, int i
)
1810 struct uart_state
*state
= drv
->state
+ i
;
1811 struct tty_port
*port
= &state
->port
;
1812 enum uart_pm_state pm_state
;
1813 struct uart_port
*uport
;
1815 unsigned int status
;
1818 mutex_lock(&port
->mutex
);
1819 uport
= uart_port_check(state
);
1823 mmio
= uport
->iotype
>= UPIO_MEM
;
1824 seq_printf(m
, "%d: uart:%s %s%08llX irq:%d",
1825 uport
->line
, uart_type(uport
),
1826 mmio
? "mmio:0x" : "port:",
1827 mmio
? (unsigned long long)uport
->mapbase
1828 : (unsigned long long)uport
->iobase
,
1831 if (uport
->type
== PORT_UNKNOWN
) {
1836 if (capable(CAP_SYS_ADMIN
)) {
1837 pm_state
= state
->pm_state
;
1838 if (pm_state
!= UART_PM_STATE_ON
)
1839 uart_change_pm(state
, UART_PM_STATE_ON
);
1840 spin_lock_irq(&uport
->lock
);
1841 status
= uport
->ops
->get_mctrl(uport
);
1842 spin_unlock_irq(&uport
->lock
);
1843 if (pm_state
!= UART_PM_STATE_ON
)
1844 uart_change_pm(state
, pm_state
);
1846 seq_printf(m
, " tx:%d rx:%d",
1847 uport
->icount
.tx
, uport
->icount
.rx
);
1848 if (uport
->icount
.frame
)
1849 seq_printf(m
, " fe:%d", uport
->icount
.frame
);
1850 if (uport
->icount
.parity
)
1851 seq_printf(m
, " pe:%d", uport
->icount
.parity
);
1852 if (uport
->icount
.brk
)
1853 seq_printf(m
, " brk:%d", uport
->icount
.brk
);
1854 if (uport
->icount
.overrun
)
1855 seq_printf(m
, " oe:%d", uport
->icount
.overrun
);
1856 if (uport
->icount
.buf_overrun
)
1857 seq_printf(m
, " bo:%d", uport
->icount
.buf_overrun
);
1859 #define INFOBIT(bit, str) \
1860 if (uport->mctrl & (bit)) \
1861 strncat(stat_buf, (str), sizeof(stat_buf) - \
1862 strlen(stat_buf) - 2)
1863 #define STATBIT(bit, str) \
1864 if (status & (bit)) \
1865 strncat(stat_buf, (str), sizeof(stat_buf) - \
1866 strlen(stat_buf) - 2)
1870 INFOBIT(TIOCM_RTS
, "|RTS");
1871 STATBIT(TIOCM_CTS
, "|CTS");
1872 INFOBIT(TIOCM_DTR
, "|DTR");
1873 STATBIT(TIOCM_DSR
, "|DSR");
1874 STATBIT(TIOCM_CAR
, "|CD");
1875 STATBIT(TIOCM_RNG
, "|RI");
1879 seq_puts(m
, stat_buf
);
1885 mutex_unlock(&port
->mutex
);
1888 static int uart_proc_show(struct seq_file
*m
, void *v
)
1890 struct tty_driver
*ttydrv
= m
->private;
1891 struct uart_driver
*drv
= ttydrv
->driver_state
;
1894 seq_printf(m
, "serinfo:1.0 driver%s%s revision:%s\n", "", "", "");
1895 for (i
= 0; i
< drv
->nr
; i
++)
1896 uart_line_info(m
, drv
, i
);
1901 #if defined(CONFIG_SERIAL_CORE_CONSOLE) || defined(CONFIG_CONSOLE_POLL)
1903 * uart_console_write - write a console message to a serial port
1904 * @port: the port to write the message
1905 * @s: array of characters
1906 * @count: number of characters in string to write
1907 * @putchar: function to write character to port
1909 void uart_console_write(struct uart_port
*port
, const char *s
,
1911 void (*putchar
)(struct uart_port
*, int))
1915 for (i
= 0; i
< count
; i
++, s
++) {
1917 putchar(port
, '\r');
1921 EXPORT_SYMBOL_GPL(uart_console_write
);
1924 * Check whether an invalid uart number has been specified, and
1925 * if so, search for the first available port that does have
1928 struct uart_port
* __init
1929 uart_get_console(struct uart_port
*ports
, int nr
, struct console
*co
)
1931 int idx
= co
->index
;
1933 if (idx
< 0 || idx
>= nr
|| (ports
[idx
].iobase
== 0 &&
1934 ports
[idx
].membase
== NULL
))
1935 for (idx
= 0; idx
< nr
; idx
++)
1936 if (ports
[idx
].iobase
!= 0 ||
1937 ports
[idx
].membase
!= NULL
)
1946 * uart_parse_earlycon - Parse earlycon options
1947 * @p: ptr to 2nd field (ie., just beyond '<name>,')
1948 * @iotype: ptr for decoded iotype (out)
1949 * @addr: ptr for decoded mapbase/iobase (out)
1950 * @options: ptr for <options> field; NULL if not present (out)
1952 * Decodes earlycon kernel command line parameters of the form
1953 * earlycon=<name>,io|mmio|mmio16|mmio32|mmio32be|mmio32native,<addr>,<options>
1954 * console=<name>,io|mmio|mmio16|mmio32|mmio32be|mmio32native,<addr>,<options>
1957 * earlycon=<name>,0x<addr>,<options>
1958 * console=<name>,0x<addr>,<options>
1959 * is also accepted; the returned @iotype will be UPIO_MEM.
1961 * Returns 0 on success or -EINVAL on failure
1963 int uart_parse_earlycon(char *p
, unsigned char *iotype
, resource_size_t
*addr
,
1966 if (strncmp(p
, "mmio,", 5) == 0) {
1969 } else if (strncmp(p
, "mmio16,", 7) == 0) {
1970 *iotype
= UPIO_MEM16
;
1972 } else if (strncmp(p
, "mmio32,", 7) == 0) {
1973 *iotype
= UPIO_MEM32
;
1975 } else if (strncmp(p
, "mmio32be,", 9) == 0) {
1976 *iotype
= UPIO_MEM32BE
;
1978 } else if (strncmp(p
, "mmio32native,", 13) == 0) {
1979 *iotype
= IS_ENABLED(CONFIG_CPU_BIG_ENDIAN
) ?
1980 UPIO_MEM32BE
: UPIO_MEM32
;
1982 } else if (strncmp(p
, "io,", 3) == 0) {
1983 *iotype
= UPIO_PORT
;
1985 } else if (strncmp(p
, "0x", 2) == 0) {
1992 * Before you replace it with kstrtoull(), think about options separator
1993 * (',') it will not tolerate
1995 *addr
= simple_strtoull(p
, NULL
, 0);
2003 EXPORT_SYMBOL_GPL(uart_parse_earlycon
);
2006 * uart_parse_options - Parse serial port baud/parity/bits/flow control.
2007 * @options: pointer to option string
2008 * @baud: pointer to an 'int' variable for the baud rate.
2009 * @parity: pointer to an 'int' variable for the parity.
2010 * @bits: pointer to an 'int' variable for the number of data bits.
2011 * @flow: pointer to an 'int' variable for the flow control character.
2013 * uart_parse_options decodes a string containing the serial console
2014 * options. The format of the string is <baud><parity><bits><flow>,
2018 uart_parse_options(const char *options
, int *baud
, int *parity
,
2019 int *bits
, int *flow
)
2021 const char *s
= options
;
2023 *baud
= simple_strtoul(s
, NULL
, 10);
2024 while (*s
>= '0' && *s
<= '9')
2033 EXPORT_SYMBOL_GPL(uart_parse_options
);
2036 * uart_set_options - setup the serial console parameters
2037 * @port: pointer to the serial ports uart_port structure
2038 * @co: console pointer
2040 * @parity: parity character - 'n' (none), 'o' (odd), 'e' (even)
2041 * @bits: number of data bits
2042 * @flow: flow control character - 'r' (rts)
2045 uart_set_options(struct uart_port
*port
, struct console
*co
,
2046 int baud
, int parity
, int bits
, int flow
)
2048 struct ktermios termios
;
2049 static struct ktermios dummy
;
2052 * Ensure that the serial console lock is initialised
2054 * If this port is a console, then the spinlock is already
2057 if (!(uart_console(port
) && (port
->cons
->flags
& CON_ENABLED
))) {
2058 spin_lock_init(&port
->lock
);
2059 lockdep_set_class(&port
->lock
, &port_lock_key
);
2062 memset(&termios
, 0, sizeof(struct ktermios
));
2064 termios
.c_cflag
|= CREAD
| HUPCL
| CLOCAL
;
2065 tty_termios_encode_baud_rate(&termios
, baud
, baud
);
2068 termios
.c_cflag
|= CS7
;
2070 termios
.c_cflag
|= CS8
;
2074 termios
.c_cflag
|= PARODD
;
2077 termios
.c_cflag
|= PARENB
;
2082 termios
.c_cflag
|= CRTSCTS
;
2085 * some uarts on other side don't support no flow control.
2086 * So we set * DTR in host uart to make them happy
2088 port
->mctrl
|= TIOCM_DTR
;
2090 port
->ops
->set_termios(port
, &termios
, &dummy
);
2092 * Allow the setting of the UART parameters with a NULL console
2096 co
->cflag
= termios
.c_cflag
;
2100 EXPORT_SYMBOL_GPL(uart_set_options
);
2101 #endif /* CONFIG_SERIAL_CORE_CONSOLE */
2104 * uart_change_pm - set power state of the port
2106 * @state: port descriptor
2107 * @pm_state: new state
2109 * Locking: port->mutex has to be held
2111 static void uart_change_pm(struct uart_state
*state
,
2112 enum uart_pm_state pm_state
)
2114 struct uart_port
*port
= uart_port_check(state
);
2116 if (state
->pm_state
!= pm_state
) {
2117 if (port
&& port
->ops
->pm
)
2118 port
->ops
->pm(port
, pm_state
, state
->pm_state
);
2119 state
->pm_state
= pm_state
;
2124 struct uart_port
*port
;
2125 struct uart_driver
*driver
;
2128 static int serial_match_port(struct device
*dev
, void *data
)
2130 struct uart_match
*match
= data
;
2131 struct tty_driver
*tty_drv
= match
->driver
->tty_driver
;
2132 dev_t devt
= MKDEV(tty_drv
->major
, tty_drv
->minor_start
) +
2135 return dev
->devt
== devt
; /* Actually, only one tty per port */
2138 int uart_suspend_port(struct uart_driver
*drv
, struct uart_port
*uport
)
2140 struct uart_state
*state
= drv
->state
+ uport
->line
;
2141 struct tty_port
*port
= &state
->port
;
2142 struct device
*tty_dev
;
2143 struct uart_match match
= {uport
, drv
};
2145 mutex_lock(&port
->mutex
);
2147 tty_dev
= device_find_child(uport
->dev
, &match
, serial_match_port
);
2148 if (tty_dev
&& device_may_wakeup(tty_dev
)) {
2149 enable_irq_wake(uport
->irq
);
2150 put_device(tty_dev
);
2151 mutex_unlock(&port
->mutex
);
2154 put_device(tty_dev
);
2156 /* Nothing to do if the console is not suspending */
2157 if (!console_suspend_enabled
&& uart_console(uport
))
2160 uport
->suspended
= 1;
2162 if (tty_port_initialized(port
)) {
2163 const struct uart_ops
*ops
= uport
->ops
;
2166 tty_port_set_suspended(port
, 1);
2167 tty_port_set_initialized(port
, 0);
2169 spin_lock_irq(&uport
->lock
);
2170 ops
->stop_tx(uport
);
2171 ops
->set_mctrl(uport
, 0);
2172 ops
->stop_rx(uport
);
2173 spin_unlock_irq(&uport
->lock
);
2176 * Wait for the transmitter to empty.
2178 for (tries
= 3; !ops
->tx_empty(uport
) && tries
; tries
--)
2181 dev_err(uport
->dev
, "%s: Unable to drain transmitter\n",
2184 ops
->shutdown(uport
);
2188 * Disable the console device before suspending.
2190 if (uart_console(uport
))
2191 console_stop(uport
->cons
);
2193 uart_change_pm(state
, UART_PM_STATE_OFF
);
2195 mutex_unlock(&port
->mutex
);
2200 int uart_resume_port(struct uart_driver
*drv
, struct uart_port
*uport
)
2202 struct uart_state
*state
= drv
->state
+ uport
->line
;
2203 struct tty_port
*port
= &state
->port
;
2204 struct device
*tty_dev
;
2205 struct uart_match match
= {uport
, drv
};
2206 struct ktermios termios
;
2208 mutex_lock(&port
->mutex
);
2210 tty_dev
= device_find_child(uport
->dev
, &match
, serial_match_port
);
2211 if (!uport
->suspended
&& device_may_wakeup(tty_dev
)) {
2212 if (irqd_is_wakeup_set(irq_get_irq_data((uport
->irq
))))
2213 disable_irq_wake(uport
->irq
);
2214 put_device(tty_dev
);
2215 mutex_unlock(&port
->mutex
);
2218 put_device(tty_dev
);
2219 uport
->suspended
= 0;
2222 * Re-enable the console device after suspending.
2224 if (uart_console(uport
)) {
2226 * First try to use the console cflag setting.
2228 memset(&termios
, 0, sizeof(struct ktermios
));
2229 termios
.c_cflag
= uport
->cons
->cflag
;
2232 * If that's unset, use the tty termios setting.
2234 if (port
->tty
&& termios
.c_cflag
== 0)
2235 termios
= port
->tty
->termios
;
2237 if (console_suspend_enabled
)
2238 uart_change_pm(state
, UART_PM_STATE_ON
);
2239 uport
->ops
->set_termios(uport
, &termios
, NULL
);
2240 if (console_suspend_enabled
)
2241 console_start(uport
->cons
);
2244 if (tty_port_suspended(port
)) {
2245 const struct uart_ops
*ops
= uport
->ops
;
2248 uart_change_pm(state
, UART_PM_STATE_ON
);
2249 spin_lock_irq(&uport
->lock
);
2250 ops
->set_mctrl(uport
, 0);
2251 spin_unlock_irq(&uport
->lock
);
2252 if (console_suspend_enabled
|| !uart_console(uport
)) {
2253 /* Protected by port mutex for now */
2254 struct tty_struct
*tty
= port
->tty
;
2255 ret
= ops
->startup(uport
);
2258 uart_change_speed(tty
, state
, NULL
);
2259 spin_lock_irq(&uport
->lock
);
2260 ops
->set_mctrl(uport
, uport
->mctrl
);
2261 ops
->start_tx(uport
);
2262 spin_unlock_irq(&uport
->lock
);
2263 tty_port_set_initialized(port
, 1);
2266 * Failed to resume - maybe hardware went away?
2267 * Clear the "initialized" flag so we won't try
2268 * to call the low level drivers shutdown method.
2270 uart_shutdown(tty
, state
);
2274 tty_port_set_suspended(port
, 0);
2277 mutex_unlock(&port
->mutex
);
2283 uart_report_port(struct uart_driver
*drv
, struct uart_port
*port
)
2287 switch (port
->iotype
) {
2289 snprintf(address
, sizeof(address
), "I/O 0x%lx", port
->iobase
);
2292 snprintf(address
, sizeof(address
),
2293 "I/O 0x%lx offset 0x%x", port
->iobase
, port
->hub6
);
2301 snprintf(address
, sizeof(address
),
2302 "MMIO 0x%llx", (unsigned long long)port
->mapbase
);
2305 strlcpy(address
, "*unknown*", sizeof(address
));
2309 pr_info("%s%s%s at %s (irq = %d, base_baud = %d) is a %s\n",
2310 port
->dev
? dev_name(port
->dev
) : "",
2311 port
->dev
? ": " : "",
2313 address
, port
->irq
, port
->uartclk
/ 16, uart_type(port
));
2317 uart_configure_port(struct uart_driver
*drv
, struct uart_state
*state
,
2318 struct uart_port
*port
)
2323 * If there isn't a port here, don't do anything further.
2325 if (!port
->iobase
&& !port
->mapbase
&& !port
->membase
)
2329 * Now do the auto configuration stuff. Note that config_port
2330 * is expected to claim the resources and map the port for us.
2333 if (port
->flags
& UPF_AUTO_IRQ
)
2334 flags
|= UART_CONFIG_IRQ
;
2335 if (port
->flags
& UPF_BOOT_AUTOCONF
) {
2336 if (!(port
->flags
& UPF_FIXED_TYPE
)) {
2337 port
->type
= PORT_UNKNOWN
;
2338 flags
|= UART_CONFIG_TYPE
;
2340 port
->ops
->config_port(port
, flags
);
2343 if (port
->type
!= PORT_UNKNOWN
) {
2344 unsigned long flags
;
2346 uart_report_port(drv
, port
);
2348 /* Power up port for set_mctrl() */
2349 uart_change_pm(state
, UART_PM_STATE_ON
);
2352 * Ensure that the modem control lines are de-activated.
2353 * keep the DTR setting that is set in uart_set_options()
2354 * We probably don't need a spinlock around this, but
2356 spin_lock_irqsave(&port
->lock
, flags
);
2357 port
->ops
->set_mctrl(port
, port
->mctrl
& TIOCM_DTR
);
2358 spin_unlock_irqrestore(&port
->lock
, flags
);
2361 * If this driver supports console, and it hasn't been
2362 * successfully registered yet, try to re-register it.
2363 * It may be that the port was not available.
2365 if (port
->cons
&& !(port
->cons
->flags
& CON_ENABLED
))
2366 register_console(port
->cons
);
2369 * Power down all ports by default, except the
2370 * console if we have one.
2372 if (!uart_console(port
))
2373 uart_change_pm(state
, UART_PM_STATE_OFF
);
2377 #ifdef CONFIG_CONSOLE_POLL
2379 static int uart_poll_init(struct tty_driver
*driver
, int line
, char *options
)
2381 struct uart_driver
*drv
= driver
->driver_state
;
2382 struct uart_state
*state
= drv
->state
+ line
;
2383 struct tty_port
*tport
;
2384 struct uart_port
*port
;
2391 tport
= &state
->port
;
2392 mutex_lock(&tport
->mutex
);
2394 port
= uart_port_check(state
);
2395 if (!port
|| !(port
->ops
->poll_get_char
&& port
->ops
->poll_put_char
)) {
2400 if (port
->ops
->poll_init
) {
2402 * We don't set initialized as we only initialized the hw,
2403 * e.g. state->xmit is still uninitialized.
2405 if (!tty_port_initialized(tport
))
2406 ret
= port
->ops
->poll_init(port
);
2409 if (!ret
&& options
) {
2410 uart_parse_options(options
, &baud
, &parity
, &bits
, &flow
);
2411 ret
= uart_set_options(port
, NULL
, baud
, parity
, bits
, flow
);
2414 mutex_unlock(&tport
->mutex
);
2418 static int uart_poll_get_char(struct tty_driver
*driver
, int line
)
2420 struct uart_driver
*drv
= driver
->driver_state
;
2421 struct uart_state
*state
= drv
->state
+ line
;
2422 struct uart_port
*port
;
2425 port
= uart_port_ref(state
);
2427 ret
= port
->ops
->poll_get_char(port
);
2428 uart_port_deref(port
);
2434 static void uart_poll_put_char(struct tty_driver
*driver
, int line
, char ch
)
2436 struct uart_driver
*drv
= driver
->driver_state
;
2437 struct uart_state
*state
= drv
->state
+ line
;
2438 struct uart_port
*port
;
2440 port
= uart_port_ref(state
);
2445 port
->ops
->poll_put_char(port
, '\r');
2446 port
->ops
->poll_put_char(port
, ch
);
2447 uart_port_deref(port
);
2451 static const struct tty_operations uart_ops
= {
2452 .install
= uart_install
,
2454 .close
= uart_close
,
2455 .write
= uart_write
,
2456 .put_char
= uart_put_char
,
2457 .flush_chars
= uart_flush_chars
,
2458 .write_room
= uart_write_room
,
2459 .chars_in_buffer
= uart_chars_in_buffer
,
2460 .flush_buffer
= uart_flush_buffer
,
2461 .ioctl
= uart_ioctl
,
2462 .throttle
= uart_throttle
,
2463 .unthrottle
= uart_unthrottle
,
2464 .send_xchar
= uart_send_xchar
,
2465 .set_termios
= uart_set_termios
,
2466 .set_ldisc
= uart_set_ldisc
,
2468 .start
= uart_start
,
2469 .hangup
= uart_hangup
,
2470 .break_ctl
= uart_break_ctl
,
2471 .wait_until_sent
= uart_wait_until_sent
,
2472 #ifdef CONFIG_PROC_FS
2473 .proc_show
= uart_proc_show
,
2475 .tiocmget
= uart_tiocmget
,
2476 .tiocmset
= uart_tiocmset
,
2477 .set_serial
= uart_set_info_user
,
2478 .get_serial
= uart_get_info_user
,
2479 .get_icount
= uart_get_icount
,
2480 #ifdef CONFIG_CONSOLE_POLL
2481 .poll_init
= uart_poll_init
,
2482 .poll_get_char
= uart_poll_get_char
,
2483 .poll_put_char
= uart_poll_put_char
,
2487 static const struct tty_port_operations uart_port_ops
= {
2488 .carrier_raised
= uart_carrier_raised
,
2489 .dtr_rts
= uart_dtr_rts
,
2490 .activate
= uart_port_activate
,
2491 .shutdown
= uart_tty_port_shutdown
,
2495 * uart_register_driver - register a driver with the uart core layer
2496 * @drv: low level driver structure
2498 * Register a uart driver with the core driver. We in turn register
2499 * with the tty layer, and initialise the core driver per-port state.
2501 * We have a proc file in /proc/tty/driver which is named after the
2504 * drv->port should be NULL, and the per-port structures should be
2505 * registered using uart_add_one_port after this call has succeeded.
2507 int uart_register_driver(struct uart_driver
*drv
)
2509 struct tty_driver
*normal
;
2510 int i
, retval
= -ENOMEM
;
2515 * Maybe we should be using a slab cache for this, especially if
2516 * we have a large number of ports to handle.
2518 drv
->state
= kcalloc(drv
->nr
, sizeof(struct uart_state
), GFP_KERNEL
);
2522 normal
= alloc_tty_driver(drv
->nr
);
2526 drv
->tty_driver
= normal
;
2528 normal
->driver_name
= drv
->driver_name
;
2529 normal
->name
= drv
->dev_name
;
2530 normal
->major
= drv
->major
;
2531 normal
->minor_start
= drv
->minor
;
2532 normal
->type
= TTY_DRIVER_TYPE_SERIAL
;
2533 normal
->subtype
= SERIAL_TYPE_NORMAL
;
2534 normal
->init_termios
= tty_std_termios
;
2535 normal
->init_termios
.c_cflag
= B9600
| CS8
| CREAD
| HUPCL
| CLOCAL
;
2536 normal
->init_termios
.c_ispeed
= normal
->init_termios
.c_ospeed
= 9600;
2537 normal
->flags
= TTY_DRIVER_REAL_RAW
| TTY_DRIVER_DYNAMIC_DEV
;
2538 normal
->driver_state
= drv
;
2539 tty_set_operations(normal
, &uart_ops
);
2542 * Initialise the UART state(s).
2544 for (i
= 0; i
< drv
->nr
; i
++) {
2545 struct uart_state
*state
= drv
->state
+ i
;
2546 struct tty_port
*port
= &state
->port
;
2548 tty_port_init(port
);
2549 port
->ops
= &uart_port_ops
;
2552 retval
= tty_register_driver(normal
);
2556 for (i
= 0; i
< drv
->nr
; i
++)
2557 tty_port_destroy(&drv
->state
[i
].port
);
2558 put_tty_driver(normal
);
2566 * uart_unregister_driver - remove a driver from the uart core layer
2567 * @drv: low level driver structure
2569 * Remove all references to a driver from the core driver. The low
2570 * level driver must have removed all its ports via the
2571 * uart_remove_one_port() if it registered them with uart_add_one_port().
2572 * (ie, drv->port == NULL)
2574 void uart_unregister_driver(struct uart_driver
*drv
)
2576 struct tty_driver
*p
= drv
->tty_driver
;
2579 tty_unregister_driver(p
);
2581 for (i
= 0; i
< drv
->nr
; i
++)
2582 tty_port_destroy(&drv
->state
[i
].port
);
2585 drv
->tty_driver
= NULL
;
2588 struct tty_driver
*uart_console_device(struct console
*co
, int *index
)
2590 struct uart_driver
*p
= co
->data
;
2592 return p
->tty_driver
;
2595 static ssize_t
uart_get_attr_uartclk(struct device
*dev
,
2596 struct device_attribute
*attr
, char *buf
)
2598 struct serial_struct tmp
;
2599 struct tty_port
*port
= dev_get_drvdata(dev
);
2601 uart_get_info(port
, &tmp
);
2602 return snprintf(buf
, PAGE_SIZE
, "%d\n", tmp
.baud_base
* 16);
2605 static ssize_t
uart_get_attr_type(struct device
*dev
,
2606 struct device_attribute
*attr
, char *buf
)
2608 struct serial_struct tmp
;
2609 struct tty_port
*port
= dev_get_drvdata(dev
);
2611 uart_get_info(port
, &tmp
);
2612 return snprintf(buf
, PAGE_SIZE
, "%d\n", tmp
.type
);
2614 static ssize_t
uart_get_attr_line(struct device
*dev
,
2615 struct device_attribute
*attr
, char *buf
)
2617 struct serial_struct tmp
;
2618 struct tty_port
*port
= dev_get_drvdata(dev
);
2620 uart_get_info(port
, &tmp
);
2621 return snprintf(buf
, PAGE_SIZE
, "%d\n", tmp
.line
);
2624 static ssize_t
uart_get_attr_port(struct device
*dev
,
2625 struct device_attribute
*attr
, char *buf
)
2627 struct serial_struct tmp
;
2628 struct tty_port
*port
= dev_get_drvdata(dev
);
2629 unsigned long ioaddr
;
2631 uart_get_info(port
, &tmp
);
2633 if (HIGH_BITS_OFFSET
)
2634 ioaddr
|= (unsigned long)tmp
.port_high
<< HIGH_BITS_OFFSET
;
2635 return snprintf(buf
, PAGE_SIZE
, "0x%lX\n", ioaddr
);
2638 static ssize_t
uart_get_attr_irq(struct device
*dev
,
2639 struct device_attribute
*attr
, char *buf
)
2641 struct serial_struct tmp
;
2642 struct tty_port
*port
= dev_get_drvdata(dev
);
2644 uart_get_info(port
, &tmp
);
2645 return snprintf(buf
, PAGE_SIZE
, "%d\n", tmp
.irq
);
2648 static ssize_t
uart_get_attr_flags(struct device
*dev
,
2649 struct device_attribute
*attr
, char *buf
)
2651 struct serial_struct tmp
;
2652 struct tty_port
*port
= dev_get_drvdata(dev
);
2654 uart_get_info(port
, &tmp
);
2655 return snprintf(buf
, PAGE_SIZE
, "0x%X\n", tmp
.flags
);
2658 static ssize_t
uart_get_attr_xmit_fifo_size(struct device
*dev
,
2659 struct device_attribute
*attr
, char *buf
)
2661 struct serial_struct tmp
;
2662 struct tty_port
*port
= dev_get_drvdata(dev
);
2664 uart_get_info(port
, &tmp
);
2665 return snprintf(buf
, PAGE_SIZE
, "%d\n", tmp
.xmit_fifo_size
);
2669 static ssize_t
uart_get_attr_close_delay(struct device
*dev
,
2670 struct device_attribute
*attr
, char *buf
)
2672 struct serial_struct tmp
;
2673 struct tty_port
*port
= dev_get_drvdata(dev
);
2675 uart_get_info(port
, &tmp
);
2676 return snprintf(buf
, PAGE_SIZE
, "%d\n", tmp
.close_delay
);
2680 static ssize_t
uart_get_attr_closing_wait(struct device
*dev
,
2681 struct device_attribute
*attr
, char *buf
)
2683 struct serial_struct tmp
;
2684 struct tty_port
*port
= dev_get_drvdata(dev
);
2686 uart_get_info(port
, &tmp
);
2687 return snprintf(buf
, PAGE_SIZE
, "%d\n", tmp
.closing_wait
);
2690 static ssize_t
uart_get_attr_custom_divisor(struct device
*dev
,
2691 struct device_attribute
*attr
, char *buf
)
2693 struct serial_struct tmp
;
2694 struct tty_port
*port
= dev_get_drvdata(dev
);
2696 uart_get_info(port
, &tmp
);
2697 return snprintf(buf
, PAGE_SIZE
, "%d\n", tmp
.custom_divisor
);
2700 static ssize_t
uart_get_attr_io_type(struct device
*dev
,
2701 struct device_attribute
*attr
, char *buf
)
2703 struct serial_struct tmp
;
2704 struct tty_port
*port
= dev_get_drvdata(dev
);
2706 uart_get_info(port
, &tmp
);
2707 return snprintf(buf
, PAGE_SIZE
, "%d\n", tmp
.io_type
);
2710 static ssize_t
uart_get_attr_iomem_base(struct device
*dev
,
2711 struct device_attribute
*attr
, char *buf
)
2713 struct serial_struct tmp
;
2714 struct tty_port
*port
= dev_get_drvdata(dev
);
2716 uart_get_info(port
, &tmp
);
2717 return snprintf(buf
, PAGE_SIZE
, "0x%lX\n", (unsigned long)tmp
.iomem_base
);
2720 static ssize_t
uart_get_attr_iomem_reg_shift(struct device
*dev
,
2721 struct device_attribute
*attr
, char *buf
)
2723 struct serial_struct tmp
;
2724 struct tty_port
*port
= dev_get_drvdata(dev
);
2726 uart_get_info(port
, &tmp
);
2727 return snprintf(buf
, PAGE_SIZE
, "%d\n", tmp
.iomem_reg_shift
);
2730 static DEVICE_ATTR(type
, S_IRUSR
| S_IRGRP
, uart_get_attr_type
, NULL
);
2731 static DEVICE_ATTR(line
, S_IRUSR
| S_IRGRP
, uart_get_attr_line
, NULL
);
2732 static DEVICE_ATTR(port
, S_IRUSR
| S_IRGRP
, uart_get_attr_port
, NULL
);
2733 static DEVICE_ATTR(irq
, S_IRUSR
| S_IRGRP
, uart_get_attr_irq
, NULL
);
2734 static DEVICE_ATTR(flags
, S_IRUSR
| S_IRGRP
, uart_get_attr_flags
, NULL
);
2735 static DEVICE_ATTR(xmit_fifo_size
, S_IRUSR
| S_IRGRP
, uart_get_attr_xmit_fifo_size
, NULL
);
2736 static DEVICE_ATTR(uartclk
, S_IRUSR
| S_IRGRP
, uart_get_attr_uartclk
, NULL
);
2737 static DEVICE_ATTR(close_delay
, S_IRUSR
| S_IRGRP
, uart_get_attr_close_delay
, NULL
);
2738 static DEVICE_ATTR(closing_wait
, S_IRUSR
| S_IRGRP
, uart_get_attr_closing_wait
, NULL
);
2739 static DEVICE_ATTR(custom_divisor
, S_IRUSR
| S_IRGRP
, uart_get_attr_custom_divisor
, NULL
);
2740 static DEVICE_ATTR(io_type
, S_IRUSR
| S_IRGRP
, uart_get_attr_io_type
, NULL
);
2741 static DEVICE_ATTR(iomem_base
, S_IRUSR
| S_IRGRP
, uart_get_attr_iomem_base
, NULL
);
2742 static DEVICE_ATTR(iomem_reg_shift
, S_IRUSR
| S_IRGRP
, uart_get_attr_iomem_reg_shift
, NULL
);
2744 static struct attribute
*tty_dev_attrs
[] = {
2745 &dev_attr_type
.attr
,
2746 &dev_attr_line
.attr
,
2747 &dev_attr_port
.attr
,
2749 &dev_attr_flags
.attr
,
2750 &dev_attr_xmit_fifo_size
.attr
,
2751 &dev_attr_uartclk
.attr
,
2752 &dev_attr_close_delay
.attr
,
2753 &dev_attr_closing_wait
.attr
,
2754 &dev_attr_custom_divisor
.attr
,
2755 &dev_attr_io_type
.attr
,
2756 &dev_attr_iomem_base
.attr
,
2757 &dev_attr_iomem_reg_shift
.attr
,
2761 static const struct attribute_group tty_dev_attr_group
= {
2762 .attrs
= tty_dev_attrs
,
2766 * uart_add_one_port - attach a driver-defined port structure
2767 * @drv: pointer to the uart low level driver structure for this port
2768 * @uport: uart port structure to use for this port.
2770 * This allows the driver to register its own uart_port structure
2771 * with the core driver. The main purpose is to allow the low
2772 * level uart drivers to expand uart_port, rather than having yet
2773 * more levels of structures.
2775 int uart_add_one_port(struct uart_driver
*drv
, struct uart_port
*uport
)
2777 struct uart_state
*state
;
2778 struct tty_port
*port
;
2780 struct device
*tty_dev
;
2783 BUG_ON(in_interrupt());
2785 if (uport
->line
>= drv
->nr
)
2788 state
= drv
->state
+ uport
->line
;
2789 port
= &state
->port
;
2791 mutex_lock(&port_mutex
);
2792 mutex_lock(&port
->mutex
);
2793 if (state
->uart_port
) {
2798 /* Link the port to the driver state table and vice versa */
2799 atomic_set(&state
->refcount
, 1);
2800 init_waitqueue_head(&state
->remove_wait
);
2801 state
->uart_port
= uport
;
2802 uport
->state
= state
;
2804 state
->pm_state
= UART_PM_STATE_UNDEFINED
;
2805 uport
->cons
= drv
->cons
;
2806 uport
->minor
= drv
->tty_driver
->minor_start
+ uport
->line
;
2807 uport
->name
= kasprintf(GFP_KERNEL
, "%s%d", drv
->dev_name
,
2808 drv
->tty_driver
->name_base
+ uport
->line
);
2815 * If this port is a console, then the spinlock is already
2818 if (!(uart_console(uport
) && (uport
->cons
->flags
& CON_ENABLED
))) {
2819 spin_lock_init(&uport
->lock
);
2820 lockdep_set_class(&uport
->lock
, &port_lock_key
);
2822 if (uport
->cons
&& uport
->dev
)
2823 of_console_check(uport
->dev
->of_node
, uport
->cons
->name
, uport
->line
);
2825 uart_configure_port(drv
, state
, uport
);
2827 port
->console
= uart_console(uport
);
2830 if (uport
->attr_group
)
2833 uport
->tty_groups
= kcalloc(num_groups
, sizeof(*uport
->tty_groups
),
2835 if (!uport
->tty_groups
) {
2839 uport
->tty_groups
[0] = &tty_dev_attr_group
;
2840 if (uport
->attr_group
)
2841 uport
->tty_groups
[1] = uport
->attr_group
;
2844 * Register the port whether it's detected or not. This allows
2845 * setserial to be used to alter this port's parameters.
2847 tty_dev
= tty_port_register_device_attr_serdev(port
, drv
->tty_driver
,
2848 uport
->line
, uport
->dev
, port
, uport
->tty_groups
);
2849 if (!IS_ERR(tty_dev
)) {
2850 device_set_wakeup_capable(tty_dev
, 1);
2852 dev_err(uport
->dev
, "Cannot register tty device on line %d\n",
2857 * Ensure UPF_DEAD is not set.
2859 uport
->flags
&= ~UPF_DEAD
;
2862 mutex_unlock(&port
->mutex
);
2863 mutex_unlock(&port_mutex
);
2869 * uart_remove_one_port - detach a driver defined port structure
2870 * @drv: pointer to the uart low level driver structure for this port
2871 * @uport: uart port structure for this port
2873 * This unhooks (and hangs up) the specified port structure from the
2874 * core driver. No further calls will be made to the low-level code
2877 int uart_remove_one_port(struct uart_driver
*drv
, struct uart_port
*uport
)
2879 struct uart_state
*state
= drv
->state
+ uport
->line
;
2880 struct tty_port
*port
= &state
->port
;
2881 struct uart_port
*uart_port
;
2882 struct tty_struct
*tty
;
2885 BUG_ON(in_interrupt());
2887 mutex_lock(&port_mutex
);
2890 * Mark the port "dead" - this prevents any opens from
2891 * succeeding while we shut down the port.
2893 mutex_lock(&port
->mutex
);
2894 uart_port
= uart_port_check(state
);
2895 if (uart_port
!= uport
)
2896 dev_alert(uport
->dev
, "Removing wrong port: %p != %p\n",
2900 mutex_unlock(&port
->mutex
);
2904 uport
->flags
|= UPF_DEAD
;
2905 mutex_unlock(&port
->mutex
);
2908 * Remove the devices from the tty layer
2910 tty_port_unregister_device(port
, drv
->tty_driver
, uport
->line
);
2912 tty
= tty_port_tty_get(port
);
2914 tty_vhangup(port
->tty
);
2919 * If the port is used as a console, unregister it
2921 if (uart_console(uport
))
2922 unregister_console(uport
->cons
);
2925 * Free the port IO and memory resources, if any.
2927 if (uport
->type
!= PORT_UNKNOWN
&& uport
->ops
->release_port
)
2928 uport
->ops
->release_port(uport
);
2929 kfree(uport
->tty_groups
);
2933 * Indicate that there isn't a port here anymore.
2935 uport
->type
= PORT_UNKNOWN
;
2937 mutex_lock(&port
->mutex
);
2938 WARN_ON(atomic_dec_return(&state
->refcount
) < 0);
2939 wait_event(state
->remove_wait
, !atomic_read(&state
->refcount
));
2940 state
->uart_port
= NULL
;
2941 mutex_unlock(&port
->mutex
);
2943 mutex_unlock(&port_mutex
);
2949 * Are the two ports equivalent?
2951 int uart_match_port(struct uart_port
*port1
, struct uart_port
*port2
)
2953 if (port1
->iotype
!= port2
->iotype
)
2956 switch (port1
->iotype
) {
2958 return (port1
->iobase
== port2
->iobase
);
2960 return (port1
->iobase
== port2
->iobase
) &&
2961 (port1
->hub6
== port2
->hub6
);
2968 return (port1
->mapbase
== port2
->mapbase
);
2972 EXPORT_SYMBOL(uart_match_port
);
2975 * uart_handle_dcd_change - handle a change of carrier detect state
2976 * @uport: uart_port structure for the open port
2977 * @status: new carrier detect status, nonzero if active
2979 * Caller must hold uport->lock
2981 void uart_handle_dcd_change(struct uart_port
*uport
, unsigned int status
)
2983 struct tty_port
*port
= &uport
->state
->port
;
2984 struct tty_struct
*tty
= port
->tty
;
2985 struct tty_ldisc
*ld
;
2987 lockdep_assert_held_once(&uport
->lock
);
2990 ld
= tty_ldisc_ref(tty
);
2992 if (ld
->ops
->dcd_change
)
2993 ld
->ops
->dcd_change(tty
, status
);
2994 tty_ldisc_deref(ld
);
2998 uport
->icount
.dcd
++;
3000 if (uart_dcd_enabled(uport
)) {
3002 wake_up_interruptible(&port
->open_wait
);
3007 EXPORT_SYMBOL_GPL(uart_handle_dcd_change
);
3010 * uart_handle_cts_change - handle a change of clear-to-send state
3011 * @uport: uart_port structure for the open port
3012 * @status: new clear to send status, nonzero if active
3014 * Caller must hold uport->lock
3016 void uart_handle_cts_change(struct uart_port
*uport
, unsigned int status
)
3018 lockdep_assert_held_once(&uport
->lock
);
3020 uport
->icount
.cts
++;
3022 if (uart_softcts_mode(uport
)) {
3023 if (uport
->hw_stopped
) {
3025 uport
->hw_stopped
= 0;
3026 uport
->ops
->start_tx(uport
);
3027 uart_write_wakeup(uport
);
3031 uport
->hw_stopped
= 1;
3032 uport
->ops
->stop_tx(uport
);
3038 EXPORT_SYMBOL_GPL(uart_handle_cts_change
);
3041 * uart_insert_char - push a char to the uart layer
3043 * User is responsible to call tty_flip_buffer_push when they are done with
3046 * @port: corresponding port
3047 * @status: state of the serial port RX buffer (LSR for 8250)
3048 * @overrun: mask of overrun bits in @status
3049 * @ch: character to push
3050 * @flag: flag for the character (see TTY_NORMAL and friends)
3052 void uart_insert_char(struct uart_port
*port
, unsigned int status
,
3053 unsigned int overrun
, unsigned int ch
, unsigned int flag
)
3055 struct tty_port
*tport
= &port
->state
->port
;
3057 if ((status
& port
->ignore_status_mask
& ~overrun
) == 0)
3058 if (tty_insert_flip_char(tport
, ch
, flag
) == 0)
3059 ++port
->icount
.buf_overrun
;
3062 * Overrun is special. Since it's reported immediately,
3063 * it doesn't affect the current character.
3065 if (status
& ~port
->ignore_status_mask
& overrun
)
3066 if (tty_insert_flip_char(tport
, 0, TTY_OVERRUN
) == 0)
3067 ++port
->icount
.buf_overrun
;
3069 EXPORT_SYMBOL_GPL(uart_insert_char
);
3071 EXPORT_SYMBOL(uart_write_wakeup
);
3072 EXPORT_SYMBOL(uart_register_driver
);
3073 EXPORT_SYMBOL(uart_unregister_driver
);
3074 EXPORT_SYMBOL(uart_suspend_port
);
3075 EXPORT_SYMBOL(uart_resume_port
);
3076 EXPORT_SYMBOL(uart_add_one_port
);
3077 EXPORT_SYMBOL(uart_remove_one_port
);
3080 * uart_get_rs485_mode() - retrieve rs485 properties for given uart
3082 * @rs485conf: output parameter
3084 * This function implements the device tree binding described in
3085 * Documentation/devicetree/bindings/serial/rs485.txt.
3087 void uart_get_rs485_mode(struct device
*dev
, struct serial_rs485
*rs485conf
)
3092 ret
= device_property_read_u32_array(dev
, "rs485-rts-delay",
3095 rs485conf
->delay_rts_before_send
= rs485_delay
[0];
3096 rs485conf
->delay_rts_after_send
= rs485_delay
[1];
3098 rs485conf
->delay_rts_before_send
= 0;
3099 rs485conf
->delay_rts_after_send
= 0;
3103 * Clear full-duplex and enabled flags, set RTS polarity to active high
3104 * to get to a defined state with the following properties:
3106 rs485conf
->flags
&= ~(SER_RS485_RX_DURING_TX
| SER_RS485_ENABLED
|
3107 SER_RS485_RTS_AFTER_SEND
);
3108 rs485conf
->flags
|= SER_RS485_RTS_ON_SEND
;
3110 if (device_property_read_bool(dev
, "rs485-rx-during-tx"))
3111 rs485conf
->flags
|= SER_RS485_RX_DURING_TX
;
3113 if (device_property_read_bool(dev
, "linux,rs485-enabled-at-boot-time"))
3114 rs485conf
->flags
|= SER_RS485_ENABLED
;
3116 if (device_property_read_bool(dev
, "rs485-rts-active-low")) {
3117 rs485conf
->flags
&= ~SER_RS485_RTS_ON_SEND
;
3118 rs485conf
->flags
|= SER_RS485_RTS_AFTER_SEND
;
3121 EXPORT_SYMBOL_GPL(uart_get_rs485_mode
);
3123 MODULE_DESCRIPTION("Serial driver core");
3124 MODULE_LICENSE("GPL");