2 * linux/drivers/char/core.c
4 * Driver core for serial ports
6 * Based on drivers/char/serial.c, by Linus Torvalds, Theodore Ts'o.
8 * Copyright 1999 ARM Limited
9 * Copyright (C) 2000-2001 Deep Blue Solutions Ltd.
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 #include <linux/module.h>
26 #include <linux/tty.h>
27 #include <linux/slab.h>
28 #include <linux/init.h>
29 #include <linux/console.h>
30 #include <linux/serial_core.h>
31 #include <linux/smp_lock.h>
32 #include <linux/device.h>
33 #include <linux/serial.h> /* for serial_state and serial_icounter_struct */
34 #include <linux/delay.h>
35 #include <linux/mutex.h>
38 #include <asm/uaccess.h>
42 #define DPRINTK(x...) printk(x)
44 #define DPRINTK(x...) do { } while (0)
48 * This is used to lock changes in serial line configuration.
50 static DEFINE_MUTEX(port_mutex
);
53 * lockdep: port->lock is initialized in two places, but we
54 * want only one lock-class:
56 static struct lock_class_key port_lock_key
;
58 #define HIGH_BITS_OFFSET ((sizeof(long)-sizeof(int))*8)
60 #define uart_users(state) ((state)->count + ((state)->info ? (state)->info->blocked_open : 0))
62 #ifdef CONFIG_SERIAL_CORE_CONSOLE
63 #define uart_console(port) ((port)->cons && (port)->cons->index == (port)->line)
65 #define uart_console(port) (0)
68 static void uart_change_speed(struct uart_state
*state
, struct termios
*old_termios
);
69 static void uart_wait_until_sent(struct tty_struct
*tty
, int timeout
);
70 static void uart_change_pm(struct uart_state
*state
, int pm_state
);
73 * This routine is used by the interrupt handler to schedule processing in
74 * the software interrupt portion of the driver.
76 void uart_write_wakeup(struct uart_port
*port
)
78 struct uart_info
*info
= port
->info
;
80 * This means you called this function _after_ the port was
81 * closed. No cookie for you.
84 tasklet_schedule(&info
->tlet
);
87 static void uart_stop(struct tty_struct
*tty
)
89 struct uart_state
*state
= tty
->driver_data
;
90 struct uart_port
*port
= state
->port
;
93 spin_lock_irqsave(&port
->lock
, flags
);
94 port
->ops
->stop_tx(port
);
95 spin_unlock_irqrestore(&port
->lock
, flags
);
98 static void __uart_start(struct tty_struct
*tty
)
100 struct uart_state
*state
= tty
->driver_data
;
101 struct uart_port
*port
= state
->port
;
103 if (!uart_circ_empty(&state
->info
->xmit
) && state
->info
->xmit
.buf
&&
104 !tty
->stopped
&& !tty
->hw_stopped
)
105 port
->ops
->start_tx(port
);
108 static void uart_start(struct tty_struct
*tty
)
110 struct uart_state
*state
= tty
->driver_data
;
111 struct uart_port
*port
= state
->port
;
114 spin_lock_irqsave(&port
->lock
, flags
);
116 spin_unlock_irqrestore(&port
->lock
, flags
);
119 static void uart_tasklet_action(unsigned long data
)
121 struct uart_state
*state
= (struct uart_state
*)data
;
122 tty_wakeup(state
->info
->tty
);
126 uart_update_mctrl(struct uart_port
*port
, unsigned int set
, unsigned int clear
)
131 spin_lock_irqsave(&port
->lock
, flags
);
133 port
->mctrl
= (old
& ~clear
) | set
;
134 if (old
!= port
->mctrl
)
135 port
->ops
->set_mctrl(port
, port
->mctrl
);
136 spin_unlock_irqrestore(&port
->lock
, flags
);
139 #define uart_set_mctrl(port,set) uart_update_mctrl(port,set,0)
140 #define uart_clear_mctrl(port,clear) uart_update_mctrl(port,0,clear)
143 * Startup the port. This will be called once per open. All calls
144 * will be serialised by the per-port semaphore.
146 static int uart_startup(struct uart_state
*state
, int init_hw
)
148 struct uart_info
*info
= state
->info
;
149 struct uart_port
*port
= state
->port
;
153 if (info
->flags
& UIF_INITIALIZED
)
157 * Set the TTY IO error marker - we will only clear this
158 * once we have successfully opened the port. Also set
159 * up the tty->alt_speed kludge
161 set_bit(TTY_IO_ERROR
, &info
->tty
->flags
);
163 if (port
->type
== PORT_UNKNOWN
)
167 * Initialise and allocate the transmit and temporary
170 if (!info
->xmit
.buf
) {
171 page
= get_zeroed_page(GFP_KERNEL
);
175 info
->xmit
.buf
= (unsigned char *) page
;
176 uart_circ_clear(&info
->xmit
);
179 retval
= port
->ops
->startup(port
);
183 * Initialise the hardware port settings.
185 uart_change_speed(state
, NULL
);
188 * Setup the RTS and DTR signals once the
189 * port is open and ready to respond.
191 if (info
->tty
->termios
->c_cflag
& CBAUD
)
192 uart_set_mctrl(port
, TIOCM_RTS
| TIOCM_DTR
);
195 if (info
->flags
& UIF_CTS_FLOW
) {
196 spin_lock_irq(&port
->lock
);
197 if (!(port
->ops
->get_mctrl(port
) & TIOCM_CTS
))
198 info
->tty
->hw_stopped
= 1;
199 spin_unlock_irq(&port
->lock
);
202 info
->flags
|= UIF_INITIALIZED
;
204 clear_bit(TTY_IO_ERROR
, &info
->tty
->flags
);
207 if (retval
&& capable(CAP_SYS_ADMIN
))
214 * This routine will shutdown a serial port; interrupts are disabled, and
215 * DTR is dropped if the hangup on close termio flag is on. Calls to
216 * uart_shutdown are serialised by the per-port semaphore.
218 static void uart_shutdown(struct uart_state
*state
)
220 struct uart_info
*info
= state
->info
;
221 struct uart_port
*port
= state
->port
;
224 * Set the TTY IO error marker
227 set_bit(TTY_IO_ERROR
, &info
->tty
->flags
);
229 if (info
->flags
& UIF_INITIALIZED
) {
230 info
->flags
&= ~UIF_INITIALIZED
;
233 * Turn off DTR and RTS early.
235 if (!info
->tty
|| (info
->tty
->termios
->c_cflag
& HUPCL
))
236 uart_clear_mctrl(port
, TIOCM_DTR
| TIOCM_RTS
);
239 * clear delta_msr_wait queue to avoid mem leaks: we may free
240 * the irq here so the queue might never be woken up. Note
241 * that we won't end up waiting on delta_msr_wait again since
242 * any outstanding file descriptors should be pointing at
243 * hung_up_tty_fops now.
245 wake_up_interruptible(&info
->delta_msr_wait
);
248 * Free the IRQ and disable the port.
250 port
->ops
->shutdown(port
);
253 * Ensure that the IRQ handler isn't running on another CPU.
255 synchronize_irq(port
->irq
);
259 * kill off our tasklet
261 tasklet_kill(&info
->tlet
);
264 * Free the transmit buffer page.
266 if (info
->xmit
.buf
) {
267 free_page((unsigned long)info
->xmit
.buf
);
268 info
->xmit
.buf
= NULL
;
273 * uart_update_timeout - update per-port FIFO timeout.
274 * @port: uart_port structure describing the port
275 * @cflag: termios cflag value
276 * @baud: speed of the port
278 * Set the port FIFO timeout value. The @cflag value should
279 * reflect the actual hardware settings.
282 uart_update_timeout(struct uart_port
*port
, unsigned int cflag
,
287 /* byte size and parity */
288 switch (cflag
& CSIZE
) {
309 * The total number of bits to be transmitted in the fifo.
311 bits
= bits
* port
->fifosize
;
314 * Figure the timeout to send the above number of bits.
315 * Add .02 seconds of slop
317 port
->timeout
= (HZ
* bits
) / baud
+ HZ
/50;
320 EXPORT_SYMBOL(uart_update_timeout
);
323 * uart_get_baud_rate - return baud rate for a particular port
324 * @port: uart_port structure describing the port in question.
325 * @termios: desired termios settings.
326 * @old: old termios (or NULL)
327 * @min: minimum acceptable baud rate
328 * @max: maximum acceptable baud rate
330 * Decode the termios structure into a numeric baud rate,
331 * taking account of the magic 38400 baud rate (with spd_*
332 * flags), and mapping the %B0 rate to 9600 baud.
334 * If the new baud rate is invalid, try the old termios setting.
335 * If it's still invalid, we try 9600 baud.
337 * Update the @termios structure to reflect the baud rate
338 * we're actually going to be using.
341 uart_get_baud_rate(struct uart_port
*port
, struct termios
*termios
,
342 struct termios
*old
, unsigned int min
, unsigned int max
)
344 unsigned int try, baud
, altbaud
= 38400;
345 upf_t flags
= port
->flags
& UPF_SPD_MASK
;
347 if (flags
== UPF_SPD_HI
)
349 if (flags
== UPF_SPD_VHI
)
351 if (flags
== UPF_SPD_SHI
)
353 if (flags
== UPF_SPD_WARP
)
356 for (try = 0; try < 2; try++) {
357 baud
= tty_termios_baud_rate(termios
);
360 * The spd_hi, spd_vhi, spd_shi, spd_warp kludge...
367 * Special case: B0 rate.
372 if (baud
>= min
&& baud
<= max
)
376 * Oops, the quotient was zero. Try again with
377 * the old baud rate if possible.
379 termios
->c_cflag
&= ~CBAUD
;
381 termios
->c_cflag
|= old
->c_cflag
& CBAUD
;
387 * As a last resort, if the quotient is zero,
388 * default to 9600 bps
390 termios
->c_cflag
|= B9600
;
396 EXPORT_SYMBOL(uart_get_baud_rate
);
399 * uart_get_divisor - return uart clock divisor
400 * @port: uart_port structure describing the port.
401 * @baud: desired baud rate
403 * Calculate the uart clock divisor for the port.
406 uart_get_divisor(struct uart_port
*port
, unsigned int baud
)
411 * Old custom speed handling.
413 if (baud
== 38400 && (port
->flags
& UPF_SPD_MASK
) == UPF_SPD_CUST
)
414 quot
= port
->custom_divisor
;
416 quot
= (port
->uartclk
+ (8 * baud
)) / (16 * baud
);
421 EXPORT_SYMBOL(uart_get_divisor
);
424 uart_change_speed(struct uart_state
*state
, struct termios
*old_termios
)
426 struct tty_struct
*tty
= state
->info
->tty
;
427 struct uart_port
*port
= state
->port
;
428 struct termios
*termios
;
431 * If we have no tty, termios, or the port does not exist,
432 * then we can't set the parameters for this port.
434 if (!tty
|| !tty
->termios
|| port
->type
== PORT_UNKNOWN
)
437 termios
= tty
->termios
;
440 * Set flags based on termios cflag
442 if (termios
->c_cflag
& CRTSCTS
)
443 state
->info
->flags
|= UIF_CTS_FLOW
;
445 state
->info
->flags
&= ~UIF_CTS_FLOW
;
447 if (termios
->c_cflag
& CLOCAL
)
448 state
->info
->flags
&= ~UIF_CHECK_CD
;
450 state
->info
->flags
|= UIF_CHECK_CD
;
452 port
->ops
->set_termios(port
, termios
, old_termios
);
456 __uart_put_char(struct uart_port
*port
, struct circ_buf
*circ
, unsigned char c
)
463 spin_lock_irqsave(&port
->lock
, flags
);
464 if (uart_circ_chars_free(circ
) != 0) {
465 circ
->buf
[circ
->head
] = c
;
466 circ
->head
= (circ
->head
+ 1) & (UART_XMIT_SIZE
- 1);
468 spin_unlock_irqrestore(&port
->lock
, flags
);
471 static void uart_put_char(struct tty_struct
*tty
, unsigned char ch
)
473 struct uart_state
*state
= tty
->driver_data
;
475 __uart_put_char(state
->port
, &state
->info
->xmit
, ch
);
478 static void uart_flush_chars(struct tty_struct
*tty
)
484 uart_write(struct tty_struct
*tty
, const unsigned char *buf
, int count
)
486 struct uart_state
*state
= tty
->driver_data
;
487 struct uart_port
*port
;
488 struct circ_buf
*circ
;
493 * This means you called this function _after_ the port was
494 * closed. No cookie for you.
496 if (!state
|| !state
->info
) {
502 circ
= &state
->info
->xmit
;
507 spin_lock_irqsave(&port
->lock
, flags
);
509 c
= CIRC_SPACE_TO_END(circ
->head
, circ
->tail
, UART_XMIT_SIZE
);
514 memcpy(circ
->buf
+ circ
->head
, buf
, c
);
515 circ
->head
= (circ
->head
+ c
) & (UART_XMIT_SIZE
- 1);
520 spin_unlock_irqrestore(&port
->lock
, flags
);
526 static int uart_write_room(struct tty_struct
*tty
)
528 struct uart_state
*state
= tty
->driver_data
;
530 return uart_circ_chars_free(&state
->info
->xmit
);
533 static int uart_chars_in_buffer(struct tty_struct
*tty
)
535 struct uart_state
*state
= tty
->driver_data
;
537 return uart_circ_chars_pending(&state
->info
->xmit
);
540 static void uart_flush_buffer(struct tty_struct
*tty
)
542 struct uart_state
*state
= tty
->driver_data
;
543 struct uart_port
*port
= state
->port
;
547 * This means you called this function _after_ the port was
548 * closed. No cookie for you.
550 if (!state
|| !state
->info
) {
555 DPRINTK("uart_flush_buffer(%d) called\n", tty
->index
);
557 spin_lock_irqsave(&port
->lock
, flags
);
558 uart_circ_clear(&state
->info
->xmit
);
559 spin_unlock_irqrestore(&port
->lock
, flags
);
564 * This function is used to send a high-priority XON/XOFF character to
567 static void uart_send_xchar(struct tty_struct
*tty
, char ch
)
569 struct uart_state
*state
= tty
->driver_data
;
570 struct uart_port
*port
= state
->port
;
573 if (port
->ops
->send_xchar
)
574 port
->ops
->send_xchar(port
, ch
);
578 spin_lock_irqsave(&port
->lock
, flags
);
579 port
->ops
->start_tx(port
);
580 spin_unlock_irqrestore(&port
->lock
, flags
);
585 static void uart_throttle(struct tty_struct
*tty
)
587 struct uart_state
*state
= tty
->driver_data
;
590 uart_send_xchar(tty
, STOP_CHAR(tty
));
592 if (tty
->termios
->c_cflag
& CRTSCTS
)
593 uart_clear_mctrl(state
->port
, TIOCM_RTS
);
596 static void uart_unthrottle(struct tty_struct
*tty
)
598 struct uart_state
*state
= tty
->driver_data
;
599 struct uart_port
*port
= state
->port
;
605 uart_send_xchar(tty
, START_CHAR(tty
));
608 if (tty
->termios
->c_cflag
& CRTSCTS
)
609 uart_set_mctrl(port
, TIOCM_RTS
);
612 static int uart_get_info(struct uart_state
*state
,
613 struct serial_struct __user
*retinfo
)
615 struct uart_port
*port
= state
->port
;
616 struct serial_struct tmp
;
618 memset(&tmp
, 0, sizeof(tmp
));
619 tmp
.type
= port
->type
;
620 tmp
.line
= port
->line
;
621 tmp
.port
= port
->iobase
;
622 if (HIGH_BITS_OFFSET
)
623 tmp
.port_high
= (long) port
->iobase
>> HIGH_BITS_OFFSET
;
625 tmp
.flags
= port
->flags
;
626 tmp
.xmit_fifo_size
= port
->fifosize
;
627 tmp
.baud_base
= port
->uartclk
/ 16;
628 tmp
.close_delay
= state
->close_delay
/ 10;
629 tmp
.closing_wait
= state
->closing_wait
== USF_CLOSING_WAIT_NONE
?
630 ASYNC_CLOSING_WAIT_NONE
:
631 state
->closing_wait
/ 10;
632 tmp
.custom_divisor
= port
->custom_divisor
;
633 tmp
.hub6
= port
->hub6
;
634 tmp
.io_type
= port
->iotype
;
635 tmp
.iomem_reg_shift
= port
->regshift
;
636 tmp
.iomem_base
= (void *)port
->mapbase
;
638 if (copy_to_user(retinfo
, &tmp
, sizeof(*retinfo
)))
643 static int uart_set_info(struct uart_state
*state
,
644 struct serial_struct __user
*newinfo
)
646 struct serial_struct new_serial
;
647 struct uart_port
*port
= state
->port
;
648 unsigned long new_port
;
649 unsigned int change_irq
, change_port
, closing_wait
;
650 unsigned int old_custom_divisor
, close_delay
;
651 upf_t old_flags
, new_flags
;
654 if (copy_from_user(&new_serial
, newinfo
, sizeof(new_serial
)))
657 new_port
= new_serial
.port
;
658 if (HIGH_BITS_OFFSET
)
659 new_port
+= (unsigned long) new_serial
.port_high
<< HIGH_BITS_OFFSET
;
661 new_serial
.irq
= irq_canonicalize(new_serial
.irq
);
662 close_delay
= new_serial
.close_delay
* 10;
663 closing_wait
= new_serial
.closing_wait
== ASYNC_CLOSING_WAIT_NONE
?
664 USF_CLOSING_WAIT_NONE
: new_serial
.closing_wait
* 10;
667 * This semaphore protects state->count. It is also
668 * very useful to prevent opens. Also, take the
669 * port configuration semaphore to make sure that a
670 * module insertion/removal doesn't change anything
673 mutex_lock(&state
->mutex
);
675 change_irq
= new_serial
.irq
!= port
->irq
;
678 * Since changing the 'type' of the port changes its resource
679 * allocations, we should treat type changes the same as
682 change_port
= new_port
!= port
->iobase
||
683 (unsigned long)new_serial
.iomem_base
!= port
->mapbase
||
684 new_serial
.hub6
!= port
->hub6
||
685 new_serial
.io_type
!= port
->iotype
||
686 new_serial
.iomem_reg_shift
!= port
->regshift
||
687 new_serial
.type
!= port
->type
;
689 old_flags
= port
->flags
;
690 new_flags
= new_serial
.flags
;
691 old_custom_divisor
= port
->custom_divisor
;
693 if (!capable(CAP_SYS_ADMIN
)) {
695 if (change_irq
|| change_port
||
696 (new_serial
.baud_base
!= port
->uartclk
/ 16) ||
697 (close_delay
!= state
->close_delay
) ||
698 (closing_wait
!= state
->closing_wait
) ||
699 (new_serial
.xmit_fifo_size
&&
700 new_serial
.xmit_fifo_size
!= port
->fifosize
) ||
701 (((new_flags
^ old_flags
) & ~UPF_USR_MASK
) != 0))
703 port
->flags
= ((port
->flags
& ~UPF_USR_MASK
) |
704 (new_flags
& UPF_USR_MASK
));
705 port
->custom_divisor
= new_serial
.custom_divisor
;
710 * Ask the low level driver to verify the settings.
712 if (port
->ops
->verify_port
)
713 retval
= port
->ops
->verify_port(port
, &new_serial
);
715 if ((new_serial
.irq
>= NR_IRQS
) || (new_serial
.irq
< 0) ||
716 (new_serial
.baud_base
< 9600))
722 if (change_port
|| change_irq
) {
726 * Make sure that we are the sole user of this port.
728 if (uart_users(state
) > 1)
732 * We need to shutdown the serial port at the old
733 * port/type/irq combination.
735 uart_shutdown(state
);
739 unsigned long old_iobase
, old_mapbase
;
740 unsigned int old_type
, old_iotype
, old_hub6
, old_shift
;
742 old_iobase
= port
->iobase
;
743 old_mapbase
= port
->mapbase
;
744 old_type
= port
->type
;
745 old_hub6
= port
->hub6
;
746 old_iotype
= port
->iotype
;
747 old_shift
= port
->regshift
;
750 * Free and release old regions
752 if (old_type
!= PORT_UNKNOWN
)
753 port
->ops
->release_port(port
);
755 port
->iobase
= new_port
;
756 port
->type
= new_serial
.type
;
757 port
->hub6
= new_serial
.hub6
;
758 port
->iotype
= new_serial
.io_type
;
759 port
->regshift
= new_serial
.iomem_reg_shift
;
760 port
->mapbase
= (unsigned long)new_serial
.iomem_base
;
763 * Claim and map the new regions
765 if (port
->type
!= PORT_UNKNOWN
) {
766 retval
= port
->ops
->request_port(port
);
768 /* Always success - Jean II */
773 * If we fail to request resources for the
774 * new port, try to restore the old settings.
776 if (retval
&& old_type
!= PORT_UNKNOWN
) {
777 port
->iobase
= old_iobase
;
778 port
->type
= old_type
;
779 port
->hub6
= old_hub6
;
780 port
->iotype
= old_iotype
;
781 port
->regshift
= old_shift
;
782 port
->mapbase
= old_mapbase
;
783 retval
= port
->ops
->request_port(port
);
785 * If we failed to restore the old settings,
789 port
->type
= PORT_UNKNOWN
;
798 port
->irq
= new_serial
.irq
;
799 port
->uartclk
= new_serial
.baud_base
* 16;
800 port
->flags
= (port
->flags
& ~UPF_CHANGE_MASK
) |
801 (new_flags
& UPF_CHANGE_MASK
);
802 port
->custom_divisor
= new_serial
.custom_divisor
;
803 state
->close_delay
= close_delay
;
804 state
->closing_wait
= closing_wait
;
805 if (new_serial
.xmit_fifo_size
)
806 port
->fifosize
= new_serial
.xmit_fifo_size
;
807 if (state
->info
->tty
)
808 state
->info
->tty
->low_latency
=
809 (port
->flags
& UPF_LOW_LATENCY
) ? 1 : 0;
813 if (port
->type
== PORT_UNKNOWN
)
815 if (state
->info
->flags
& UIF_INITIALIZED
) {
816 if (((old_flags
^ port
->flags
) & UPF_SPD_MASK
) ||
817 old_custom_divisor
!= port
->custom_divisor
) {
819 * If they're setting up a custom divisor or speed,
820 * instead of clearing it, then bitch about it. No
821 * need to rate-limit; it's CAP_SYS_ADMIN only.
823 if (port
->flags
& UPF_SPD_MASK
) {
826 "%s sets custom speed on %s. This "
827 "is deprecated.\n", current
->comm
,
828 tty_name(state
->info
->tty
, buf
));
830 uart_change_speed(state
, NULL
);
833 retval
= uart_startup(state
, 1);
835 mutex_unlock(&state
->mutex
);
841 * uart_get_lsr_info - get line status register info.
842 * Note: uart_ioctl protects us against hangups.
844 static int uart_get_lsr_info(struct uart_state
*state
,
845 unsigned int __user
*value
)
847 struct uart_port
*port
= state
->port
;
850 result
= port
->ops
->tx_empty(port
);
853 * If we're about to load something into the transmit
854 * register, we'll pretend the transmitter isn't empty to
855 * avoid a race condition (depending on when the transmit
856 * interrupt happens).
859 ((uart_circ_chars_pending(&state
->info
->xmit
) > 0) &&
860 !state
->info
->tty
->stopped
&& !state
->info
->tty
->hw_stopped
))
861 result
&= ~TIOCSER_TEMT
;
863 return put_user(result
, value
);
866 static int uart_tiocmget(struct tty_struct
*tty
, struct file
*file
)
868 struct uart_state
*state
= tty
->driver_data
;
869 struct uart_port
*port
= state
->port
;
872 mutex_lock(&state
->mutex
);
873 if ((!file
|| !tty_hung_up_p(file
)) &&
874 !(tty
->flags
& (1 << TTY_IO_ERROR
))) {
875 result
= port
->mctrl
;
877 spin_lock_irq(&port
->lock
);
878 result
|= port
->ops
->get_mctrl(port
);
879 spin_unlock_irq(&port
->lock
);
881 mutex_unlock(&state
->mutex
);
887 uart_tiocmset(struct tty_struct
*tty
, struct file
*file
,
888 unsigned int set
, unsigned int clear
)
890 struct uart_state
*state
= tty
->driver_data
;
891 struct uart_port
*port
= state
->port
;
894 mutex_lock(&state
->mutex
);
895 if ((!file
|| !tty_hung_up_p(file
)) &&
896 !(tty
->flags
& (1 << TTY_IO_ERROR
))) {
897 uart_update_mctrl(port
, set
, clear
);
900 mutex_unlock(&state
->mutex
);
904 static void uart_break_ctl(struct tty_struct
*tty
, int break_state
)
906 struct uart_state
*state
= tty
->driver_data
;
907 struct uart_port
*port
= state
->port
;
909 BUG_ON(!kernel_locked());
911 mutex_lock(&state
->mutex
);
913 if (port
->type
!= PORT_UNKNOWN
)
914 port
->ops
->break_ctl(port
, break_state
);
916 mutex_unlock(&state
->mutex
);
919 static int uart_do_autoconfig(struct uart_state
*state
)
921 struct uart_port
*port
= state
->port
;
924 if (!capable(CAP_SYS_ADMIN
))
928 * Take the per-port semaphore. This prevents count from
929 * changing, and hence any extra opens of the port while
930 * we're auto-configuring.
932 if (mutex_lock_interruptible(&state
->mutex
))
936 if (uart_users(state
) == 1) {
937 uart_shutdown(state
);
940 * If we already have a port type configured,
941 * we must release its resources.
943 if (port
->type
!= PORT_UNKNOWN
)
944 port
->ops
->release_port(port
);
946 flags
= UART_CONFIG_TYPE
;
947 if (port
->flags
& UPF_AUTO_IRQ
)
948 flags
|= UART_CONFIG_IRQ
;
951 * This will claim the ports resources if
954 port
->ops
->config_port(port
, flags
);
956 ret
= uart_startup(state
, 1);
958 mutex_unlock(&state
->mutex
);
963 * Wait for any of the 4 modem inputs (DCD,RI,DSR,CTS) to change
964 * - mask passed in arg for lines of interest
965 * (use |'ed TIOCM_RNG/DSR/CD/CTS for masking)
966 * Caller should use TIOCGICOUNT to see which one it was
969 uart_wait_modem_status(struct uart_state
*state
, unsigned long arg
)
971 struct uart_port
*port
= state
->port
;
972 DECLARE_WAITQUEUE(wait
, current
);
973 struct uart_icount cprev
, cnow
;
977 * note the counters on entry
979 spin_lock_irq(&port
->lock
);
980 memcpy(&cprev
, &port
->icount
, sizeof(struct uart_icount
));
983 * Force modem status interrupts on
985 port
->ops
->enable_ms(port
);
986 spin_unlock_irq(&port
->lock
);
988 add_wait_queue(&state
->info
->delta_msr_wait
, &wait
);
990 spin_lock_irq(&port
->lock
);
991 memcpy(&cnow
, &port
->icount
, sizeof(struct uart_icount
));
992 spin_unlock_irq(&port
->lock
);
994 set_current_state(TASK_INTERRUPTIBLE
);
996 if (((arg
& TIOCM_RNG
) && (cnow
.rng
!= cprev
.rng
)) ||
997 ((arg
& TIOCM_DSR
) && (cnow
.dsr
!= cprev
.dsr
)) ||
998 ((arg
& TIOCM_CD
) && (cnow
.dcd
!= cprev
.dcd
)) ||
999 ((arg
& TIOCM_CTS
) && (cnow
.cts
!= cprev
.cts
))) {
1006 /* see if a signal did it */
1007 if (signal_pending(current
)) {
1015 current
->state
= TASK_RUNNING
;
1016 remove_wait_queue(&state
->info
->delta_msr_wait
, &wait
);
1022 * Get counter of input serial line interrupts (DCD,RI,DSR,CTS)
1023 * Return: write counters to the user passed counter struct
1024 * NB: both 1->0 and 0->1 transitions are counted except for
1025 * RI where only 0->1 is counted.
1027 static int uart_get_count(struct uart_state
*state
,
1028 struct serial_icounter_struct __user
*icnt
)
1030 struct serial_icounter_struct icount
;
1031 struct uart_icount cnow
;
1032 struct uart_port
*port
= state
->port
;
1034 spin_lock_irq(&port
->lock
);
1035 memcpy(&cnow
, &port
->icount
, sizeof(struct uart_icount
));
1036 spin_unlock_irq(&port
->lock
);
1038 icount
.cts
= cnow
.cts
;
1039 icount
.dsr
= cnow
.dsr
;
1040 icount
.rng
= cnow
.rng
;
1041 icount
.dcd
= cnow
.dcd
;
1042 icount
.rx
= cnow
.rx
;
1043 icount
.tx
= cnow
.tx
;
1044 icount
.frame
= cnow
.frame
;
1045 icount
.overrun
= cnow
.overrun
;
1046 icount
.parity
= cnow
.parity
;
1047 icount
.brk
= cnow
.brk
;
1048 icount
.buf_overrun
= cnow
.buf_overrun
;
1050 return copy_to_user(icnt
, &icount
, sizeof(icount
)) ? -EFAULT
: 0;
1054 * Called via sys_ioctl under the BKL. We can use spin_lock_irq() here.
1057 uart_ioctl(struct tty_struct
*tty
, struct file
*filp
, unsigned int cmd
,
1060 struct uart_state
*state
= tty
->driver_data
;
1061 void __user
*uarg
= (void __user
*)arg
;
1062 int ret
= -ENOIOCTLCMD
;
1064 BUG_ON(!kernel_locked());
1067 * These ioctls don't rely on the hardware to be present.
1071 ret
= uart_get_info(state
, uarg
);
1075 ret
= uart_set_info(state
, uarg
);
1079 ret
= uart_do_autoconfig(state
);
1082 case TIOCSERGWILD
: /* obsolete */
1083 case TIOCSERSWILD
: /* obsolete */
1088 if (ret
!= -ENOIOCTLCMD
)
1091 if (tty
->flags
& (1 << TTY_IO_ERROR
)) {
1097 * The following should only be used when hardware is present.
1101 ret
= uart_wait_modem_status(state
, arg
);
1105 ret
= uart_get_count(state
, uarg
);
1109 if (ret
!= -ENOIOCTLCMD
)
1112 mutex_lock(&state
->mutex
);
1114 if (tty_hung_up_p(filp
)) {
1120 * All these rely on hardware being present and need to be
1121 * protected against the tty being hung up.
1124 case TIOCSERGETLSR
: /* Get line status register */
1125 ret
= uart_get_lsr_info(state
, uarg
);
1129 struct uart_port
*port
= state
->port
;
1130 if (port
->ops
->ioctl
)
1131 ret
= port
->ops
->ioctl(port
, cmd
, arg
);
1136 mutex_unlock(&state
->mutex
);
1141 static void uart_set_termios(struct tty_struct
*tty
, struct termios
*old_termios
)
1143 struct uart_state
*state
= tty
->driver_data
;
1144 unsigned long flags
;
1145 unsigned int cflag
= tty
->termios
->c_cflag
;
1147 BUG_ON(!kernel_locked());
1150 * These are the bits that are used to setup various
1151 * flags in the low level driver.
1153 #define RELEVANT_IFLAG(iflag) ((iflag) & (IGNBRK|BRKINT|IGNPAR|PARMRK|INPCK))
1155 if ((cflag
^ old_termios
->c_cflag
) == 0 &&
1156 RELEVANT_IFLAG(tty
->termios
->c_iflag
^ old_termios
->c_iflag
) == 0)
1159 uart_change_speed(state
, old_termios
);
1161 /* Handle transition to B0 status */
1162 if ((old_termios
->c_cflag
& CBAUD
) && !(cflag
& CBAUD
))
1163 uart_clear_mctrl(state
->port
, TIOCM_RTS
| TIOCM_DTR
);
1165 /* Handle transition away from B0 status */
1166 if (!(old_termios
->c_cflag
& CBAUD
) && (cflag
& CBAUD
)) {
1167 unsigned int mask
= TIOCM_DTR
;
1168 if (!(cflag
& CRTSCTS
) ||
1169 !test_bit(TTY_THROTTLED
, &tty
->flags
))
1171 uart_set_mctrl(state
->port
, mask
);
1174 /* Handle turning off CRTSCTS */
1175 if ((old_termios
->c_cflag
& CRTSCTS
) && !(cflag
& CRTSCTS
)) {
1176 spin_lock_irqsave(&state
->port
->lock
, flags
);
1177 tty
->hw_stopped
= 0;
1179 spin_unlock_irqrestore(&state
->port
->lock
, flags
);
1182 /* Handle turning on CRTSCTS */
1183 if (!(old_termios
->c_cflag
& CRTSCTS
) && (cflag
& CRTSCTS
)) {
1184 spin_lock_irqsave(&state
->port
->lock
, flags
);
1185 if (!(state
->port
->ops
->get_mctrl(state
->port
) & TIOCM_CTS
)) {
1186 tty
->hw_stopped
= 1;
1187 state
->port
->ops
->stop_tx(state
->port
);
1189 spin_unlock_irqrestore(&state
->port
->lock
, flags
);
1194 * No need to wake up processes in open wait, since they
1195 * sample the CLOCAL flag once, and don't recheck it.
1196 * XXX It's not clear whether the current behavior is correct
1197 * or not. Hence, this may change.....
1199 if (!(old_termios
->c_cflag
& CLOCAL
) &&
1200 (tty
->termios
->c_cflag
& CLOCAL
))
1201 wake_up_interruptible(&state
->info
->open_wait
);
1206 * In 2.4.5, calls to this will be serialized via the BKL in
1207 * linux/drivers/char/tty_io.c:tty_release()
1208 * linux/drivers/char/tty_io.c:do_tty_handup()
1210 static void uart_close(struct tty_struct
*tty
, struct file
*filp
)
1212 struct uart_state
*state
= tty
->driver_data
;
1213 struct uart_port
*port
;
1215 BUG_ON(!kernel_locked());
1217 if (!state
|| !state
->port
)
1222 DPRINTK("uart_close(%d) called\n", port
->line
);
1224 mutex_lock(&state
->mutex
);
1226 if (tty_hung_up_p(filp
))
1229 if ((tty
->count
== 1) && (state
->count
!= 1)) {
1231 * Uh, oh. tty->count is 1, which means that the tty
1232 * structure will be freed. state->count should always
1233 * be one in these conditions. If it's greater than
1234 * one, we've got real problems, since it means the
1235 * serial port won't be shutdown.
1237 printk(KERN_ERR
"uart_close: bad serial port count; tty->count is 1, "
1238 "state->count is %d\n", state
->count
);
1241 if (--state
->count
< 0) {
1242 printk(KERN_ERR
"uart_close: bad serial port count for %s: %d\n",
1243 tty
->name
, state
->count
);
1250 * Now we wait for the transmit buffer to clear; and we notify
1251 * the line discipline to only process XON/XOFF characters by
1252 * setting tty->closing.
1256 if (state
->closing_wait
!= USF_CLOSING_WAIT_NONE
)
1257 tty_wait_until_sent(tty
, msecs_to_jiffies(state
->closing_wait
));
1260 * At this point, we stop accepting input. To do this, we
1261 * disable the receive line status interrupts.
1263 if (state
->info
->flags
& UIF_INITIALIZED
) {
1264 unsigned long flags
;
1265 spin_lock_irqsave(&port
->lock
, flags
);
1266 port
->ops
->stop_rx(port
);
1267 spin_unlock_irqrestore(&port
->lock
, flags
);
1269 * Before we drop DTR, make sure the UART transmitter
1270 * has completely drained; this is especially
1271 * important if there is a transmit FIFO!
1273 uart_wait_until_sent(tty
, port
->timeout
);
1276 uart_shutdown(state
);
1277 uart_flush_buffer(tty
);
1279 tty_ldisc_flush(tty
);
1282 state
->info
->tty
= NULL
;
1284 if (state
->info
->blocked_open
) {
1285 if (state
->close_delay
)
1286 msleep_interruptible(state
->close_delay
);
1287 } else if (!uart_console(port
)) {
1288 uart_change_pm(state
, 3);
1292 * Wake up anyone trying to open this port.
1294 state
->info
->flags
&= ~UIF_NORMAL_ACTIVE
;
1295 wake_up_interruptible(&state
->info
->open_wait
);
1298 mutex_unlock(&state
->mutex
);
1301 static void uart_wait_until_sent(struct tty_struct
*tty
, int timeout
)
1303 struct uart_state
*state
= tty
->driver_data
;
1304 struct uart_port
*port
= state
->port
;
1305 unsigned long char_time
, expire
;
1307 BUG_ON(!kernel_locked());
1309 if (port
->type
== PORT_UNKNOWN
|| port
->fifosize
== 0)
1313 * Set the check interval to be 1/5 of the estimated time to
1314 * send a single character, and make it at least 1. The check
1315 * interval should also be less than the timeout.
1317 * Note: we have to use pretty tight timings here to satisfy
1320 char_time
= (port
->timeout
- HZ
/50) / port
->fifosize
;
1321 char_time
= char_time
/ 5;
1324 if (timeout
&& timeout
< char_time
)
1325 char_time
= timeout
;
1328 * If the transmitter hasn't cleared in twice the approximate
1329 * amount of time to send the entire FIFO, it probably won't
1330 * ever clear. This assumes the UART isn't doing flow
1331 * control, which is currently the case. Hence, if it ever
1332 * takes longer than port->timeout, this is probably due to a
1333 * UART bug of some kind. So, we clamp the timeout parameter at
1336 if (timeout
== 0 || timeout
> 2 * port
->timeout
)
1337 timeout
= 2 * port
->timeout
;
1339 expire
= jiffies
+ timeout
;
1341 DPRINTK("uart_wait_until_sent(%d), jiffies=%lu, expire=%lu...\n",
1342 port
->line
, jiffies
, expire
);
1345 * Check whether the transmitter is empty every 'char_time'.
1346 * 'timeout' / 'expire' give us the maximum amount of time
1349 while (!port
->ops
->tx_empty(port
)) {
1350 msleep_interruptible(jiffies_to_msecs(char_time
));
1351 if (signal_pending(current
))
1353 if (time_after(jiffies
, expire
))
1356 set_current_state(TASK_RUNNING
); /* might not be needed */
1360 * This is called with the BKL held in
1361 * linux/drivers/char/tty_io.c:do_tty_hangup()
1362 * We're called from the eventd thread, so we can sleep for
1363 * a _short_ time only.
1365 static void uart_hangup(struct tty_struct
*tty
)
1367 struct uart_state
*state
= tty
->driver_data
;
1369 BUG_ON(!kernel_locked());
1370 DPRINTK("uart_hangup(%d)\n", state
->port
->line
);
1372 mutex_lock(&state
->mutex
);
1373 if (state
->info
&& state
->info
->flags
& UIF_NORMAL_ACTIVE
) {
1374 uart_flush_buffer(tty
);
1375 uart_shutdown(state
);
1377 state
->info
->flags
&= ~UIF_NORMAL_ACTIVE
;
1378 state
->info
->tty
= NULL
;
1379 wake_up_interruptible(&state
->info
->open_wait
);
1380 wake_up_interruptible(&state
->info
->delta_msr_wait
);
1382 mutex_unlock(&state
->mutex
);
1386 * Copy across the serial console cflag setting into the termios settings
1387 * for the initial open of the port. This allows continuity between the
1388 * kernel settings, and the settings init adopts when it opens the port
1389 * for the first time.
1391 static void uart_update_termios(struct uart_state
*state
)
1393 struct tty_struct
*tty
= state
->info
->tty
;
1394 struct uart_port
*port
= state
->port
;
1396 if (uart_console(port
) && port
->cons
->cflag
) {
1397 tty
->termios
->c_cflag
= port
->cons
->cflag
;
1398 port
->cons
->cflag
= 0;
1402 * If the device failed to grab its irq resources,
1403 * or some other error occurred, don't try to talk
1404 * to the port hardware.
1406 if (!(tty
->flags
& (1 << TTY_IO_ERROR
))) {
1408 * Make termios settings take effect.
1410 uart_change_speed(state
, NULL
);
1413 * And finally enable the RTS and DTR signals.
1415 if (tty
->termios
->c_cflag
& CBAUD
)
1416 uart_set_mctrl(port
, TIOCM_DTR
| TIOCM_RTS
);
1421 * Block the open until the port is ready. We must be called with
1422 * the per-port semaphore held.
1425 uart_block_til_ready(struct file
*filp
, struct uart_state
*state
)
1427 DECLARE_WAITQUEUE(wait
, current
);
1428 struct uart_info
*info
= state
->info
;
1429 struct uart_port
*port
= state
->port
;
1432 info
->blocked_open
++;
1435 add_wait_queue(&info
->open_wait
, &wait
);
1437 set_current_state(TASK_INTERRUPTIBLE
);
1440 * If we have been hung up, tell userspace/restart open.
1442 if (tty_hung_up_p(filp
) || info
->tty
== NULL
)
1446 * If the port has been closed, tell userspace/restart open.
1448 if (!(info
->flags
& UIF_INITIALIZED
))
1452 * If non-blocking mode is set, or CLOCAL mode is set,
1453 * we don't want to wait for the modem status lines to
1454 * indicate that the port is ready.
1456 * Also, if the port is not enabled/configured, we want
1457 * to allow the open to succeed here. Note that we will
1458 * have set TTY_IO_ERROR for a non-existant port.
1460 if ((filp
->f_flags
& O_NONBLOCK
) ||
1461 (info
->tty
->termios
->c_cflag
& CLOCAL
) ||
1462 (info
->tty
->flags
& (1 << TTY_IO_ERROR
))) {
1467 * Set DTR to allow modem to know we're waiting. Do
1468 * not set RTS here - we want to make sure we catch
1469 * the data from the modem.
1471 if (info
->tty
->termios
->c_cflag
& CBAUD
)
1472 uart_set_mctrl(port
, TIOCM_DTR
);
1475 * and wait for the carrier to indicate that the
1476 * modem is ready for us.
1478 spin_lock_irq(&port
->lock
);
1479 port
->ops
->enable_ms(port
);
1480 mctrl
= port
->ops
->get_mctrl(port
);
1481 spin_unlock_irq(&port
->lock
);
1482 if (mctrl
& TIOCM_CAR
)
1485 mutex_unlock(&state
->mutex
);
1487 mutex_lock(&state
->mutex
);
1489 if (signal_pending(current
))
1492 set_current_state(TASK_RUNNING
);
1493 remove_wait_queue(&info
->open_wait
, &wait
);
1496 info
->blocked_open
--;
1498 if (signal_pending(current
))
1499 return -ERESTARTSYS
;
1501 if (!info
->tty
|| tty_hung_up_p(filp
))
1507 static struct uart_state
*uart_get(struct uart_driver
*drv
, int line
)
1509 struct uart_state
*state
;
1512 state
= drv
->state
+ line
;
1513 if (mutex_lock_interruptible(&state
->mutex
)) {
1519 if (!state
->port
|| state
->port
->flags
& UPF_DEAD
) {
1525 state
->info
= kmalloc(sizeof(struct uart_info
), GFP_KERNEL
);
1527 memset(state
->info
, 0, sizeof(struct uart_info
));
1528 init_waitqueue_head(&state
->info
->open_wait
);
1529 init_waitqueue_head(&state
->info
->delta_msr_wait
);
1532 * Link the info into the other structures.
1534 state
->port
->info
= state
->info
;
1536 tasklet_init(&state
->info
->tlet
, uart_tasklet_action
,
1537 (unsigned long)state
);
1547 mutex_unlock(&state
->mutex
);
1549 return ERR_PTR(ret
);
1553 * In 2.4.5, calls to uart_open are serialised by the BKL in
1554 * linux/fs/devices.c:chrdev_open()
1555 * Note that if this fails, then uart_close() _will_ be called.
1557 * In time, we want to scrap the "opening nonpresent ports"
1558 * behaviour and implement an alternative way for setserial
1559 * to set base addresses/ports/types. This will allow us to
1560 * get rid of a certain amount of extra tests.
1562 static int uart_open(struct tty_struct
*tty
, struct file
*filp
)
1564 struct uart_driver
*drv
= (struct uart_driver
*)tty
->driver
->driver_state
;
1565 struct uart_state
*state
;
1566 int retval
, line
= tty
->index
;
1568 BUG_ON(!kernel_locked());
1569 DPRINTK("uart_open(%d) called\n", line
);
1572 * tty->driver->num won't change, so we won't fail here with
1573 * tty->driver_data set to something non-NULL (and therefore
1574 * we won't get caught by uart_close()).
1577 if (line
>= tty
->driver
->num
)
1581 * We take the semaphore inside uart_get to guarantee that we won't
1582 * be re-entered while allocating the info structure, or while we
1583 * request any IRQs that the driver may need. This also has the nice
1584 * side-effect that it delays the action of uart_hangup, so we can
1585 * guarantee that info->tty will always contain something reasonable.
1587 state
= uart_get(drv
, line
);
1588 if (IS_ERR(state
)) {
1589 retval
= PTR_ERR(state
);
1594 * Once we set tty->driver_data here, we are guaranteed that
1595 * uart_close() will decrement the driver module use count.
1596 * Any failures from here onwards should not touch the count.
1598 tty
->driver_data
= state
;
1599 tty
->low_latency
= (state
->port
->flags
& UPF_LOW_LATENCY
) ? 1 : 0;
1601 state
->info
->tty
= tty
;
1604 * If the port is in the middle of closing, bail out now.
1606 if (tty_hung_up_p(filp
)) {
1609 mutex_unlock(&state
->mutex
);
1614 * Make sure the device is in D0 state.
1616 if (state
->count
== 1)
1617 uart_change_pm(state
, 0);
1620 * Start up the serial port.
1622 retval
= uart_startup(state
, 0);
1625 * If we succeeded, wait until the port is ready.
1628 retval
= uart_block_til_ready(filp
, state
);
1629 mutex_unlock(&state
->mutex
);
1632 * If this is the first open to succeed, adjust things to suit.
1634 if (retval
== 0 && !(state
->info
->flags
& UIF_NORMAL_ACTIVE
)) {
1635 state
->info
->flags
|= UIF_NORMAL_ACTIVE
;
1637 uart_update_termios(state
);
1644 static const char *uart_type(struct uart_port
*port
)
1646 const char *str
= NULL
;
1648 if (port
->ops
->type
)
1649 str
= port
->ops
->type(port
);
1657 #ifdef CONFIG_PROC_FS
1659 static int uart_line_info(char *buf
, struct uart_driver
*drv
, int i
)
1661 struct uart_state
*state
= drv
->state
+ i
;
1662 struct uart_port
*port
= state
->port
;
1664 unsigned int status
;
1670 ret
= sprintf(buf
, "%d: uart:%s %s%08lX irq:%d",
1671 port
->line
, uart_type(port
),
1672 port
->iotype
== UPIO_MEM
? "mmio:0x" : "port:",
1673 port
->iotype
== UPIO_MEM
? port
->mapbase
:
1674 (unsigned long) port
->iobase
,
1677 if (port
->type
== PORT_UNKNOWN
) {
1682 if(capable(CAP_SYS_ADMIN
))
1684 spin_lock_irq(&port
->lock
);
1685 status
= port
->ops
->get_mctrl(port
);
1686 spin_unlock_irq(&port
->lock
);
1688 ret
+= sprintf(buf
+ ret
, " tx:%d rx:%d",
1689 port
->icount
.tx
, port
->icount
.rx
);
1690 if (port
->icount
.frame
)
1691 ret
+= sprintf(buf
+ ret
, " fe:%d",
1692 port
->icount
.frame
);
1693 if (port
->icount
.parity
)
1694 ret
+= sprintf(buf
+ ret
, " pe:%d",
1695 port
->icount
.parity
);
1696 if (port
->icount
.brk
)
1697 ret
+= sprintf(buf
+ ret
, " brk:%d",
1699 if (port
->icount
.overrun
)
1700 ret
+= sprintf(buf
+ ret
, " oe:%d",
1701 port
->icount
.overrun
);
1703 #define INFOBIT(bit,str) \
1704 if (port->mctrl & (bit)) \
1705 strncat(stat_buf, (str), sizeof(stat_buf) - \
1706 strlen(stat_buf) - 2)
1707 #define STATBIT(bit,str) \
1708 if (status & (bit)) \
1709 strncat(stat_buf, (str), sizeof(stat_buf) - \
1710 strlen(stat_buf) - 2)
1714 INFOBIT(TIOCM_RTS
, "|RTS");
1715 STATBIT(TIOCM_CTS
, "|CTS");
1716 INFOBIT(TIOCM_DTR
, "|DTR");
1717 STATBIT(TIOCM_DSR
, "|DSR");
1718 STATBIT(TIOCM_CAR
, "|CD");
1719 STATBIT(TIOCM_RNG
, "|RI");
1722 strcat(stat_buf
, "\n");
1724 ret
+= sprintf(buf
+ ret
, stat_buf
);
1734 static int uart_read_proc(char *page
, char **start
, off_t off
,
1735 int count
, int *eof
, void *data
)
1737 struct tty_driver
*ttydrv
= data
;
1738 struct uart_driver
*drv
= ttydrv
->driver_state
;
1742 len
+= sprintf(page
, "serinfo:1.0 driver%s%s revision:%s\n",
1744 for (i
= 0; i
< drv
->nr
&& len
< PAGE_SIZE
- 96; i
++) {
1745 l
= uart_line_info(page
+ len
, drv
, i
);
1747 if (len
+ begin
> off
+ count
)
1749 if (len
+ begin
< off
) {
1756 if (off
>= len
+ begin
)
1758 *start
= page
+ (off
- begin
);
1759 return (count
< begin
+ len
- off
) ? count
: (begin
+ len
- off
);
1763 #ifdef CONFIG_SERIAL_CORE_CONSOLE
1765 * uart_console_write - write a console message to a serial port
1766 * @port: the port to write the message
1767 * @s: array of characters
1768 * @count: number of characters in string to write
1769 * @write: function to write character to port
1771 void uart_console_write(struct uart_port
*port
, const char *s
,
1773 void (*putchar
)(struct uart_port
*, int))
1777 for (i
= 0; i
< count
; i
++, s
++) {
1779 putchar(port
, '\r');
1783 EXPORT_SYMBOL_GPL(uart_console_write
);
1786 * Check whether an invalid uart number has been specified, and
1787 * if so, search for the first available port that does have
1790 struct uart_port
* __init
1791 uart_get_console(struct uart_port
*ports
, int nr
, struct console
*co
)
1793 int idx
= co
->index
;
1795 if (idx
< 0 || idx
>= nr
|| (ports
[idx
].iobase
== 0 &&
1796 ports
[idx
].membase
== NULL
))
1797 for (idx
= 0; idx
< nr
; idx
++)
1798 if (ports
[idx
].iobase
!= 0 ||
1799 ports
[idx
].membase
!= NULL
)
1808 * uart_parse_options - Parse serial port baud/parity/bits/flow contro.
1809 * @options: pointer to option string
1810 * @baud: pointer to an 'int' variable for the baud rate.
1811 * @parity: pointer to an 'int' variable for the parity.
1812 * @bits: pointer to an 'int' variable for the number of data bits.
1813 * @flow: pointer to an 'int' variable for the flow control character.
1815 * uart_parse_options decodes a string containing the serial console
1816 * options. The format of the string is <baud><parity><bits><flow>,
1820 uart_parse_options(char *options
, int *baud
, int *parity
, int *bits
, int *flow
)
1824 *baud
= simple_strtoul(s
, NULL
, 10);
1825 while (*s
>= '0' && *s
<= '9')
1840 static const struct baud_rates baud_rates
[] = {
1841 { 921600, B921600
},
1842 { 460800, B460800
},
1843 { 230400, B230400
},
1844 { 115200, B115200
},
1856 * uart_set_options - setup the serial console parameters
1857 * @port: pointer to the serial ports uart_port structure
1858 * @co: console pointer
1860 * @parity: parity character - 'n' (none), 'o' (odd), 'e' (even)
1861 * @bits: number of data bits
1862 * @flow: flow control character - 'r' (rts)
1865 uart_set_options(struct uart_port
*port
, struct console
*co
,
1866 int baud
, int parity
, int bits
, int flow
)
1868 struct termios termios
;
1872 * Ensure that the serial console lock is initialised
1875 spin_lock_init(&port
->lock
);
1876 lockdep_set_class(&port
->lock
, &port_lock_key
);
1878 memset(&termios
, 0, sizeof(struct termios
));
1880 termios
.c_cflag
= CREAD
| HUPCL
| CLOCAL
;
1883 * Construct a cflag setting.
1885 for (i
= 0; baud_rates
[i
].rate
; i
++)
1886 if (baud_rates
[i
].rate
<= baud
)
1889 termios
.c_cflag
|= baud_rates
[i
].cflag
;
1892 termios
.c_cflag
|= CS7
;
1894 termios
.c_cflag
|= CS8
;
1898 termios
.c_cflag
|= PARODD
;
1901 termios
.c_cflag
|= PARENB
;
1906 termios
.c_cflag
|= CRTSCTS
;
1908 port
->ops
->set_termios(port
, &termios
, NULL
);
1909 co
->cflag
= termios
.c_cflag
;
1913 #endif /* CONFIG_SERIAL_CORE_CONSOLE */
1915 static void uart_change_pm(struct uart_state
*state
, int pm_state
)
1917 struct uart_port
*port
= state
->port
;
1919 if (state
->pm_state
!= pm_state
) {
1921 port
->ops
->pm(port
, pm_state
, state
->pm_state
);
1922 state
->pm_state
= pm_state
;
1926 int uart_suspend_port(struct uart_driver
*drv
, struct uart_port
*port
)
1928 struct uart_state
*state
= drv
->state
+ port
->line
;
1930 mutex_lock(&state
->mutex
);
1932 if (state
->info
&& state
->info
->flags
& UIF_INITIALIZED
) {
1933 const struct uart_ops
*ops
= port
->ops
;
1935 spin_lock_irq(&port
->lock
);
1937 ops
->set_mctrl(port
, 0);
1939 spin_unlock_irq(&port
->lock
);
1942 * Wait for the transmitter to empty.
1944 while (!ops
->tx_empty(port
)) {
1948 ops
->shutdown(port
);
1952 * Disable the console device before suspending.
1954 if (uart_console(port
))
1955 console_stop(port
->cons
);
1957 uart_change_pm(state
, 3);
1959 mutex_unlock(&state
->mutex
);
1964 int uart_resume_port(struct uart_driver
*drv
, struct uart_port
*port
)
1966 struct uart_state
*state
= drv
->state
+ port
->line
;
1968 mutex_lock(&state
->mutex
);
1970 uart_change_pm(state
, 0);
1973 * Re-enable the console device after suspending.
1975 if (uart_console(port
)) {
1976 struct termios termios
;
1979 * First try to use the console cflag setting.
1981 memset(&termios
, 0, sizeof(struct termios
));
1982 termios
.c_cflag
= port
->cons
->cflag
;
1985 * If that's unset, use the tty termios setting.
1987 if (state
->info
&& state
->info
->tty
&& termios
.c_cflag
== 0)
1988 termios
= *state
->info
->tty
->termios
;
1990 port
->ops
->set_termios(port
, &termios
, NULL
);
1991 console_start(port
->cons
);
1994 if (state
->info
&& state
->info
->flags
& UIF_INITIALIZED
) {
1995 const struct uart_ops
*ops
= port
->ops
;
1998 ops
->set_mctrl(port
, 0);
1999 ret
= ops
->startup(port
);
2001 uart_change_speed(state
, NULL
);
2002 spin_lock_irq(&port
->lock
);
2003 ops
->set_mctrl(port
, port
->mctrl
);
2004 ops
->start_tx(port
);
2005 spin_unlock_irq(&port
->lock
);
2008 * Failed to resume - maybe hardware went away?
2009 * Clear the "initialized" flag so we won't try
2010 * to call the low level drivers shutdown method.
2012 state
->info
->flags
&= ~UIF_INITIALIZED
;
2013 uart_shutdown(state
);
2017 mutex_unlock(&state
->mutex
);
2023 uart_report_port(struct uart_driver
*drv
, struct uart_port
*port
)
2027 switch (port
->iotype
) {
2029 snprintf(address
, sizeof(address
),
2030 "I/O 0x%x", port
->iobase
);
2033 snprintf(address
, sizeof(address
),
2034 "I/O 0x%x offset 0x%x", port
->iobase
, port
->hub6
);
2040 snprintf(address
, sizeof(address
),
2041 "MMIO 0x%lx", port
->mapbase
);
2044 strlcpy(address
, "*unknown*", sizeof(address
));
2048 printk(KERN_INFO
"%s%s%s%d at %s (irq = %d) is a %s\n",
2049 port
->dev
? port
->dev
->bus_id
: "",
2050 port
->dev
? ": " : "",
2051 drv
->dev_name
, port
->line
, address
, port
->irq
, uart_type(port
));
2055 uart_configure_port(struct uart_driver
*drv
, struct uart_state
*state
,
2056 struct uart_port
*port
)
2061 * If there isn't a port here, don't do anything further.
2063 if (!port
->iobase
&& !port
->mapbase
&& !port
->membase
)
2067 * Now do the auto configuration stuff. Note that config_port
2068 * is expected to claim the resources and map the port for us.
2070 flags
= UART_CONFIG_TYPE
;
2071 if (port
->flags
& UPF_AUTO_IRQ
)
2072 flags
|= UART_CONFIG_IRQ
;
2073 if (port
->flags
& UPF_BOOT_AUTOCONF
) {
2074 port
->type
= PORT_UNKNOWN
;
2075 port
->ops
->config_port(port
, flags
);
2078 if (port
->type
!= PORT_UNKNOWN
) {
2079 unsigned long flags
;
2081 uart_report_port(drv
, port
);
2084 * Ensure that the modem control lines are de-activated.
2085 * We probably don't need a spinlock around this, but
2087 spin_lock_irqsave(&port
->lock
, flags
);
2088 port
->ops
->set_mctrl(port
, 0);
2089 spin_unlock_irqrestore(&port
->lock
, flags
);
2092 * Power down all ports by default, except the
2093 * console if we have one.
2095 if (!uart_console(port
))
2096 uart_change_pm(state
, 3);
2100 static struct tty_operations uart_ops
= {
2102 .close
= uart_close
,
2103 .write
= uart_write
,
2104 .put_char
= uart_put_char
,
2105 .flush_chars
= uart_flush_chars
,
2106 .write_room
= uart_write_room
,
2107 .chars_in_buffer
= uart_chars_in_buffer
,
2108 .flush_buffer
= uart_flush_buffer
,
2109 .ioctl
= uart_ioctl
,
2110 .throttle
= uart_throttle
,
2111 .unthrottle
= uart_unthrottle
,
2112 .send_xchar
= uart_send_xchar
,
2113 .set_termios
= uart_set_termios
,
2115 .start
= uart_start
,
2116 .hangup
= uart_hangup
,
2117 .break_ctl
= uart_break_ctl
,
2118 .wait_until_sent
= uart_wait_until_sent
,
2119 #ifdef CONFIG_PROC_FS
2120 .read_proc
= uart_read_proc
,
2122 .tiocmget
= uart_tiocmget
,
2123 .tiocmset
= uart_tiocmset
,
2127 * uart_register_driver - register a driver with the uart core layer
2128 * @drv: low level driver structure
2130 * Register a uart driver with the core driver. We in turn register
2131 * with the tty layer, and initialise the core driver per-port state.
2133 * We have a proc file in /proc/tty/driver which is named after the
2136 * drv->port should be NULL, and the per-port structures should be
2137 * registered using uart_add_one_port after this call has succeeded.
2139 int uart_register_driver(struct uart_driver
*drv
)
2141 struct tty_driver
*normal
= NULL
;
2147 * Maybe we should be using a slab cache for this, especially if
2148 * we have a large number of ports to handle.
2150 drv
->state
= kmalloc(sizeof(struct uart_state
) * drv
->nr
, GFP_KERNEL
);
2155 memset(drv
->state
, 0, sizeof(struct uart_state
) * drv
->nr
);
2157 normal
= alloc_tty_driver(drv
->nr
);
2161 drv
->tty_driver
= normal
;
2163 normal
->owner
= drv
->owner
;
2164 normal
->driver_name
= drv
->driver_name
;
2165 normal
->name
= drv
->dev_name
;
2166 normal
->major
= drv
->major
;
2167 normal
->minor_start
= drv
->minor
;
2168 normal
->type
= TTY_DRIVER_TYPE_SERIAL
;
2169 normal
->subtype
= SERIAL_TYPE_NORMAL
;
2170 normal
->init_termios
= tty_std_termios
;
2171 normal
->init_termios
.c_cflag
= B9600
| CS8
| CREAD
| HUPCL
| CLOCAL
;
2172 normal
->flags
= TTY_DRIVER_REAL_RAW
| TTY_DRIVER_DYNAMIC_DEV
;
2173 normal
->driver_state
= drv
;
2174 tty_set_operations(normal
, &uart_ops
);
2177 * Initialise the UART state(s).
2179 for (i
= 0; i
< drv
->nr
; i
++) {
2180 struct uart_state
*state
= drv
->state
+ i
;
2182 state
->close_delay
= 500; /* .5 seconds */
2183 state
->closing_wait
= 30000; /* 30 seconds */
2185 mutex_init(&state
->mutex
);
2188 retval
= tty_register_driver(normal
);
2191 put_tty_driver(normal
);
2198 * uart_unregister_driver - remove a driver from the uart core layer
2199 * @drv: low level driver structure
2201 * Remove all references to a driver from the core driver. The low
2202 * level driver must have removed all its ports via the
2203 * uart_remove_one_port() if it registered them with uart_add_one_port().
2204 * (ie, drv->port == NULL)
2206 void uart_unregister_driver(struct uart_driver
*drv
)
2208 struct tty_driver
*p
= drv
->tty_driver
;
2209 tty_unregister_driver(p
);
2212 drv
->tty_driver
= NULL
;
2215 struct tty_driver
*uart_console_device(struct console
*co
, int *index
)
2217 struct uart_driver
*p
= co
->data
;
2219 return p
->tty_driver
;
2223 * uart_add_one_port - attach a driver-defined port structure
2224 * @drv: pointer to the uart low level driver structure for this port
2225 * @port: uart port structure to use for this port.
2227 * This allows the driver to register its own uart_port structure
2228 * with the core driver. The main purpose is to allow the low
2229 * level uart drivers to expand uart_port, rather than having yet
2230 * more levels of structures.
2232 int uart_add_one_port(struct uart_driver
*drv
, struct uart_port
*port
)
2234 struct uart_state
*state
;
2237 BUG_ON(in_interrupt());
2239 if (port
->line
>= drv
->nr
)
2242 state
= drv
->state
+ port
->line
;
2244 mutex_lock(&port_mutex
);
2245 mutex_lock(&state
->mutex
);
2253 port
->cons
= drv
->cons
;
2254 port
->info
= state
->info
;
2257 * If this port is a console, then the spinlock is already
2260 if (!(uart_console(port
) && (port
->cons
->flags
& CON_ENABLED
))) {
2261 spin_lock_init(&port
->lock
);
2262 lockdep_set_class(&port
->lock
, &port_lock_key
);
2265 uart_configure_port(drv
, state
, port
);
2268 * Register the port whether it's detected or not. This allows
2269 * setserial to be used to alter this ports parameters.
2271 tty_register_device(drv
->tty_driver
, port
->line
, port
->dev
);
2274 * If this driver supports console, and it hasn't been
2275 * successfully registered yet, try to re-register it.
2276 * It may be that the port was not available.
2278 if (port
->type
!= PORT_UNKNOWN
&&
2279 port
->cons
&& !(port
->cons
->flags
& CON_ENABLED
))
2280 register_console(port
->cons
);
2283 * Ensure UPF_DEAD is not set.
2285 port
->flags
&= ~UPF_DEAD
;
2288 mutex_unlock(&state
->mutex
);
2289 mutex_unlock(&port_mutex
);
2295 * uart_remove_one_port - detach a driver defined port structure
2296 * @drv: pointer to the uart low level driver structure for this port
2297 * @port: uart port structure for this port
2299 * This unhooks (and hangs up) the specified port structure from the
2300 * core driver. No further calls will be made to the low-level code
2303 int uart_remove_one_port(struct uart_driver
*drv
, struct uart_port
*port
)
2305 struct uart_state
*state
= drv
->state
+ port
->line
;
2306 struct uart_info
*info
;
2308 BUG_ON(in_interrupt());
2310 if (state
->port
!= port
)
2311 printk(KERN_ALERT
"Removing wrong port: %p != %p\n",
2314 mutex_lock(&port_mutex
);
2317 * Mark the port "dead" - this prevents any opens from
2318 * succeeding while we shut down the port.
2320 mutex_lock(&state
->mutex
);
2321 port
->flags
|= UPF_DEAD
;
2322 mutex_unlock(&state
->mutex
);
2325 * Remove the devices from the tty layer
2327 tty_unregister_device(drv
->tty_driver
, port
->line
);
2330 if (info
&& info
->tty
)
2331 tty_vhangup(info
->tty
);
2334 * All users of this port should now be disconnected from
2335 * this driver, and the port shut down. We should be the
2336 * only thread fiddling with this port from now on.
2341 * Free the port IO and memory resources, if any.
2343 if (port
->type
!= PORT_UNKNOWN
)
2344 port
->ops
->release_port(port
);
2347 * Indicate that there isn't a port here anymore.
2349 port
->type
= PORT_UNKNOWN
;
2352 * Kill the tasklet, and free resources.
2355 tasklet_kill(&info
->tlet
);
2360 mutex_unlock(&port_mutex
);
2366 * Are the two ports equivalent?
2368 int uart_match_port(struct uart_port
*port1
, struct uart_port
*port2
)
2370 if (port1
->iotype
!= port2
->iotype
)
2373 switch (port1
->iotype
) {
2375 return (port1
->iobase
== port2
->iobase
);
2377 return (port1
->iobase
== port2
->iobase
) &&
2378 (port1
->hub6
== port2
->hub6
);
2380 return (port1
->mapbase
== port2
->mapbase
);
2384 EXPORT_SYMBOL(uart_match_port
);
2386 EXPORT_SYMBOL(uart_write_wakeup
);
2387 EXPORT_SYMBOL(uart_register_driver
);
2388 EXPORT_SYMBOL(uart_unregister_driver
);
2389 EXPORT_SYMBOL(uart_suspend_port
);
2390 EXPORT_SYMBOL(uart_resume_port
);
2391 EXPORT_SYMBOL(uart_add_one_port
);
2392 EXPORT_SYMBOL(uart_remove_one_port
);
2394 MODULE_DESCRIPTION("Serial driver core");
2395 MODULE_LICENSE("GPL");