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/config.h>
26 #include <linux/module.h>
27 #include <linux/tty.h>
28 #include <linux/slab.h>
29 #include <linux/init.h>
30 #include <linux/console.h>
31 #include <linux/serial_core.h>
32 #include <linux/smp_lock.h>
33 #include <linux/device.h>
34 #include <linux/serial.h> /* for serial_state and serial_icounter_struct */
35 #include <linux/delay.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 DECLARE_MUTEX(port_sem
);
52 #define HIGH_BITS_OFFSET ((sizeof(long)-sizeof(int))*8)
54 #define uart_users(state) ((state)->count + ((state)->info ? (state)->info->blocked_open : 0))
56 #ifdef CONFIG_SERIAL_CORE_CONSOLE
57 #define uart_console(port) ((port)->cons && (port)->cons->index == (port)->line)
59 #define uart_console(port) (0)
62 static void uart_change_speed(struct uart_state
*state
, struct termios
*old_termios
);
63 static void uart_wait_until_sent(struct tty_struct
*tty
, int timeout
);
64 static void uart_change_pm(struct uart_state
*state
, int pm_state
);
67 * This routine is used by the interrupt handler to schedule processing in
68 * the software interrupt portion of the driver.
70 void uart_write_wakeup(struct uart_port
*port
)
72 struct uart_info
*info
= port
->info
;
73 tasklet_schedule(&info
->tlet
);
76 static void uart_stop(struct tty_struct
*tty
)
78 struct uart_state
*state
= tty
->driver_data
;
79 struct uart_port
*port
= state
->port
;
82 spin_lock_irqsave(&port
->lock
, flags
);
83 port
->ops
->stop_tx(port
);
84 spin_unlock_irqrestore(&port
->lock
, flags
);
87 static void __uart_start(struct tty_struct
*tty
)
89 struct uart_state
*state
= tty
->driver_data
;
90 struct uart_port
*port
= state
->port
;
92 if (!uart_circ_empty(&state
->info
->xmit
) && state
->info
->xmit
.buf
&&
93 !tty
->stopped
&& !tty
->hw_stopped
)
94 port
->ops
->start_tx(port
);
97 static void uart_start(struct tty_struct
*tty
)
99 struct uart_state
*state
= tty
->driver_data
;
100 struct uart_port
*port
= state
->port
;
103 spin_lock_irqsave(&port
->lock
, flags
);
105 spin_unlock_irqrestore(&port
->lock
, flags
);
108 static void uart_tasklet_action(unsigned long data
)
110 struct uart_state
*state
= (struct uart_state
*)data
;
111 tty_wakeup(state
->info
->tty
);
115 uart_update_mctrl(struct uart_port
*port
, unsigned int set
, unsigned int clear
)
120 spin_lock_irqsave(&port
->lock
, flags
);
122 port
->mctrl
= (old
& ~clear
) | set
;
123 if (old
!= port
->mctrl
)
124 port
->ops
->set_mctrl(port
, port
->mctrl
);
125 spin_unlock_irqrestore(&port
->lock
, flags
);
128 #define uart_set_mctrl(port,set) uart_update_mctrl(port,set,0)
129 #define uart_clear_mctrl(port,clear) uart_update_mctrl(port,0,clear)
132 * Startup the port. This will be called once per open. All calls
133 * will be serialised by the per-port semaphore.
135 static int uart_startup(struct uart_state
*state
, int init_hw
)
137 struct uart_info
*info
= state
->info
;
138 struct uart_port
*port
= state
->port
;
142 if (info
->flags
& UIF_INITIALIZED
)
146 * Set the TTY IO error marker - we will only clear this
147 * once we have successfully opened the port. Also set
148 * up the tty->alt_speed kludge
150 set_bit(TTY_IO_ERROR
, &info
->tty
->flags
);
152 if (port
->type
== PORT_UNKNOWN
)
156 * Initialise and allocate the transmit and temporary
159 if (!info
->xmit
.buf
) {
160 page
= get_zeroed_page(GFP_KERNEL
);
164 info
->xmit
.buf
= (unsigned char *) page
;
165 uart_circ_clear(&info
->xmit
);
168 retval
= port
->ops
->startup(port
);
172 * Initialise the hardware port settings.
174 uart_change_speed(state
, NULL
);
177 * Setup the RTS and DTR signals once the
178 * port is open and ready to respond.
180 if (info
->tty
->termios
->c_cflag
& CBAUD
)
181 uart_set_mctrl(port
, TIOCM_RTS
| TIOCM_DTR
);
184 if (info
->flags
& UIF_CTS_FLOW
) {
185 spin_lock_irq(&port
->lock
);
186 if (!(port
->ops
->get_mctrl(port
) & TIOCM_CTS
))
187 info
->tty
->hw_stopped
= 1;
188 spin_unlock_irq(&port
->lock
);
191 info
->flags
|= UIF_INITIALIZED
;
193 clear_bit(TTY_IO_ERROR
, &info
->tty
->flags
);
196 if (retval
&& capable(CAP_SYS_ADMIN
))
203 * This routine will shutdown a serial port; interrupts are disabled, and
204 * DTR is dropped if the hangup on close termio flag is on. Calls to
205 * uart_shutdown are serialised by the per-port semaphore.
207 static void uart_shutdown(struct uart_state
*state
)
209 struct uart_info
*info
= state
->info
;
210 struct uart_port
*port
= state
->port
;
213 * Set the TTY IO error marker
216 set_bit(TTY_IO_ERROR
, &info
->tty
->flags
);
218 if (info
->flags
& UIF_INITIALIZED
) {
219 info
->flags
&= ~UIF_INITIALIZED
;
222 * Turn off DTR and RTS early.
224 if (!info
->tty
|| (info
->tty
->termios
->c_cflag
& HUPCL
))
225 uart_clear_mctrl(port
, TIOCM_DTR
| TIOCM_RTS
);
228 * clear delta_msr_wait queue to avoid mem leaks: we may free
229 * the irq here so the queue might never be woken up. Note
230 * that we won't end up waiting on delta_msr_wait again since
231 * any outstanding file descriptors should be pointing at
232 * hung_up_tty_fops now.
234 wake_up_interruptible(&info
->delta_msr_wait
);
237 * Free the IRQ and disable the port.
239 port
->ops
->shutdown(port
);
242 * Ensure that the IRQ handler isn't running on another CPU.
244 synchronize_irq(port
->irq
);
248 * kill off our tasklet
250 tasklet_kill(&info
->tlet
);
253 * Free the transmit buffer page.
255 if (info
->xmit
.buf
) {
256 free_page((unsigned long)info
->xmit
.buf
);
257 info
->xmit
.buf
= NULL
;
262 * uart_update_timeout - update per-port FIFO timeout.
263 * @port: uart_port structure describing the port
264 * @cflag: termios cflag value
265 * @baud: speed of the port
267 * Set the port FIFO timeout value. The @cflag value should
268 * reflect the actual hardware settings.
271 uart_update_timeout(struct uart_port
*port
, unsigned int cflag
,
276 /* byte size and parity */
277 switch (cflag
& CSIZE
) {
298 * The total number of bits to be transmitted in the fifo.
300 bits
= bits
* port
->fifosize
;
303 * Figure the timeout to send the above number of bits.
304 * Add .02 seconds of slop
306 port
->timeout
= (HZ
* bits
) / baud
+ HZ
/50;
309 EXPORT_SYMBOL(uart_update_timeout
);
312 * uart_get_baud_rate - return baud rate for a particular port
313 * @port: uart_port structure describing the port in question.
314 * @termios: desired termios settings.
315 * @old: old termios (or NULL)
316 * @min: minimum acceptable baud rate
317 * @max: maximum acceptable baud rate
319 * Decode the termios structure into a numeric baud rate,
320 * taking account of the magic 38400 baud rate (with spd_*
321 * flags), and mapping the %B0 rate to 9600 baud.
323 * If the new baud rate is invalid, try the old termios setting.
324 * If it's still invalid, we try 9600 baud.
326 * Update the @termios structure to reflect the baud rate
327 * we're actually going to be using.
330 uart_get_baud_rate(struct uart_port
*port
, struct termios
*termios
,
331 struct termios
*old
, unsigned int min
, unsigned int max
)
333 unsigned int try, baud
, altbaud
= 38400;
334 unsigned int flags
= port
->flags
& UPF_SPD_MASK
;
336 if (flags
== UPF_SPD_HI
)
338 if (flags
== UPF_SPD_VHI
)
340 if (flags
== UPF_SPD_SHI
)
342 if (flags
== UPF_SPD_WARP
)
345 for (try = 0; try < 2; try++) {
346 baud
= tty_termios_baud_rate(termios
);
349 * The spd_hi, spd_vhi, spd_shi, spd_warp kludge...
356 * Special case: B0 rate.
361 if (baud
>= min
&& baud
<= max
)
365 * Oops, the quotient was zero. Try again with
366 * the old baud rate if possible.
368 termios
->c_cflag
&= ~CBAUD
;
370 termios
->c_cflag
|= old
->c_cflag
& CBAUD
;
376 * As a last resort, if the quotient is zero,
377 * default to 9600 bps
379 termios
->c_cflag
|= B9600
;
385 EXPORT_SYMBOL(uart_get_baud_rate
);
388 * uart_get_divisor - return uart clock divisor
389 * @port: uart_port structure describing the port.
390 * @baud: desired baud rate
392 * Calculate the uart clock divisor for the port.
395 uart_get_divisor(struct uart_port
*port
, unsigned int baud
)
400 * Old custom speed handling.
402 if (baud
== 38400 && (port
->flags
& UPF_SPD_MASK
) == UPF_SPD_CUST
)
403 quot
= port
->custom_divisor
;
405 quot
= (port
->uartclk
+ (8 * baud
)) / (16 * baud
);
410 EXPORT_SYMBOL(uart_get_divisor
);
413 uart_change_speed(struct uart_state
*state
, struct termios
*old_termios
)
415 struct tty_struct
*tty
= state
->info
->tty
;
416 struct uart_port
*port
= state
->port
;
417 struct termios
*termios
;
420 * If we have no tty, termios, or the port does not exist,
421 * then we can't set the parameters for this port.
423 if (!tty
|| !tty
->termios
|| port
->type
== PORT_UNKNOWN
)
426 termios
= tty
->termios
;
429 * Set flags based on termios cflag
431 if (termios
->c_cflag
& CRTSCTS
)
432 state
->info
->flags
|= UIF_CTS_FLOW
;
434 state
->info
->flags
&= ~UIF_CTS_FLOW
;
436 if (termios
->c_cflag
& CLOCAL
)
437 state
->info
->flags
&= ~UIF_CHECK_CD
;
439 state
->info
->flags
|= UIF_CHECK_CD
;
441 port
->ops
->set_termios(port
, termios
, old_termios
);
445 __uart_put_char(struct uart_port
*port
, struct circ_buf
*circ
, unsigned char c
)
452 spin_lock_irqsave(&port
->lock
, flags
);
453 if (uart_circ_chars_free(circ
) != 0) {
454 circ
->buf
[circ
->head
] = c
;
455 circ
->head
= (circ
->head
+ 1) & (UART_XMIT_SIZE
- 1);
457 spin_unlock_irqrestore(&port
->lock
, flags
);
460 static void uart_put_char(struct tty_struct
*tty
, unsigned char ch
)
462 struct uart_state
*state
= tty
->driver_data
;
464 __uart_put_char(state
->port
, &state
->info
->xmit
, ch
);
467 static void uart_flush_chars(struct tty_struct
*tty
)
473 uart_write(struct tty_struct
*tty
, const unsigned char * buf
, int count
)
475 struct uart_state
*state
= tty
->driver_data
;
476 struct uart_port
*port
= state
->port
;
477 struct circ_buf
*circ
= &state
->info
->xmit
;
484 spin_lock_irqsave(&port
->lock
, flags
);
486 c
= CIRC_SPACE_TO_END(circ
->head
, circ
->tail
, UART_XMIT_SIZE
);
491 memcpy(circ
->buf
+ circ
->head
, buf
, c
);
492 circ
->head
= (circ
->head
+ c
) & (UART_XMIT_SIZE
- 1);
497 spin_unlock_irqrestore(&port
->lock
, flags
);
503 static int uart_write_room(struct tty_struct
*tty
)
505 struct uart_state
*state
= tty
->driver_data
;
507 return uart_circ_chars_free(&state
->info
->xmit
);
510 static int uart_chars_in_buffer(struct tty_struct
*tty
)
512 struct uart_state
*state
= tty
->driver_data
;
514 return uart_circ_chars_pending(&state
->info
->xmit
);
517 static void uart_flush_buffer(struct tty_struct
*tty
)
519 struct uart_state
*state
= tty
->driver_data
;
520 struct uart_port
*port
= state
->port
;
523 DPRINTK("uart_flush_buffer(%d) called\n", tty
->index
);
525 spin_lock_irqsave(&port
->lock
, flags
);
526 uart_circ_clear(&state
->info
->xmit
);
527 spin_unlock_irqrestore(&port
->lock
, flags
);
532 * This function is used to send a high-priority XON/XOFF character to
535 static void uart_send_xchar(struct tty_struct
*tty
, char ch
)
537 struct uart_state
*state
= tty
->driver_data
;
538 struct uart_port
*port
= state
->port
;
541 if (port
->ops
->send_xchar
)
542 port
->ops
->send_xchar(port
, ch
);
546 spin_lock_irqsave(&port
->lock
, flags
);
547 port
->ops
->start_tx(port
);
548 spin_unlock_irqrestore(&port
->lock
, flags
);
553 static void uart_throttle(struct tty_struct
*tty
)
555 struct uart_state
*state
= tty
->driver_data
;
558 uart_send_xchar(tty
, STOP_CHAR(tty
));
560 if (tty
->termios
->c_cflag
& CRTSCTS
)
561 uart_clear_mctrl(state
->port
, TIOCM_RTS
);
564 static void uart_unthrottle(struct tty_struct
*tty
)
566 struct uart_state
*state
= tty
->driver_data
;
567 struct uart_port
*port
= state
->port
;
573 uart_send_xchar(tty
, START_CHAR(tty
));
576 if (tty
->termios
->c_cflag
& CRTSCTS
)
577 uart_set_mctrl(port
, TIOCM_RTS
);
580 static int uart_get_info(struct uart_state
*state
,
581 struct serial_struct __user
*retinfo
)
583 struct uart_port
*port
= state
->port
;
584 struct serial_struct tmp
;
586 memset(&tmp
, 0, sizeof(tmp
));
587 tmp
.type
= port
->type
;
588 tmp
.line
= port
->line
;
589 tmp
.port
= port
->iobase
;
590 if (HIGH_BITS_OFFSET
)
591 tmp
.port_high
= (long) port
->iobase
>> HIGH_BITS_OFFSET
;
593 tmp
.flags
= port
->flags
;
594 tmp
.xmit_fifo_size
= port
->fifosize
;
595 tmp
.baud_base
= port
->uartclk
/ 16;
596 tmp
.close_delay
= state
->close_delay
/ 10;
597 tmp
.closing_wait
= state
->closing_wait
== USF_CLOSING_WAIT_NONE
?
598 ASYNC_CLOSING_WAIT_NONE
:
599 state
->closing_wait
/ 10;
600 tmp
.custom_divisor
= port
->custom_divisor
;
601 tmp
.hub6
= port
->hub6
;
602 tmp
.io_type
= port
->iotype
;
603 tmp
.iomem_reg_shift
= port
->regshift
;
604 tmp
.iomem_base
= (void *)port
->mapbase
;
606 if (copy_to_user(retinfo
, &tmp
, sizeof(*retinfo
)))
611 static int uart_set_info(struct uart_state
*state
,
612 struct serial_struct __user
*newinfo
)
614 struct serial_struct new_serial
;
615 struct uart_port
*port
= state
->port
;
616 unsigned long new_port
;
617 unsigned int change_irq
, change_port
, old_flags
, closing_wait
;
618 unsigned int old_custom_divisor
, close_delay
;
621 if (copy_from_user(&new_serial
, newinfo
, sizeof(new_serial
)))
624 new_port
= new_serial
.port
;
625 if (HIGH_BITS_OFFSET
)
626 new_port
+= (unsigned long) new_serial
.port_high
<< HIGH_BITS_OFFSET
;
628 new_serial
.irq
= irq_canonicalize(new_serial
.irq
);
629 close_delay
= new_serial
.close_delay
* 10;
630 closing_wait
= new_serial
.closing_wait
== ASYNC_CLOSING_WAIT_NONE
?
631 USF_CLOSING_WAIT_NONE
: new_serial
.closing_wait
* 10;
634 * This semaphore protects state->count. It is also
635 * very useful to prevent opens. Also, take the
636 * port configuration semaphore to make sure that a
637 * module insertion/removal doesn't change anything
642 change_irq
= new_serial
.irq
!= port
->irq
;
645 * Since changing the 'type' of the port changes its resource
646 * allocations, we should treat type changes the same as
649 change_port
= new_port
!= port
->iobase
||
650 (unsigned long)new_serial
.iomem_base
!= port
->mapbase
||
651 new_serial
.hub6
!= port
->hub6
||
652 new_serial
.io_type
!= port
->iotype
||
653 new_serial
.iomem_reg_shift
!= port
->regshift
||
654 new_serial
.type
!= port
->type
;
656 old_flags
= port
->flags
;
657 old_custom_divisor
= port
->custom_divisor
;
659 if (!capable(CAP_SYS_ADMIN
)) {
661 if (change_irq
|| change_port
||
662 (new_serial
.baud_base
!= port
->uartclk
/ 16) ||
663 (close_delay
!= state
->close_delay
) ||
664 (closing_wait
!= state
->closing_wait
) ||
665 (new_serial
.xmit_fifo_size
!= port
->fifosize
) ||
666 (((new_serial
.flags
^ old_flags
) & ~UPF_USR_MASK
) != 0))
668 port
->flags
= ((port
->flags
& ~UPF_USR_MASK
) |
669 (new_serial
.flags
& UPF_USR_MASK
));
670 port
->custom_divisor
= new_serial
.custom_divisor
;
675 * Ask the low level driver to verify the settings.
677 if (port
->ops
->verify_port
)
678 retval
= port
->ops
->verify_port(port
, &new_serial
);
680 if ((new_serial
.irq
>= NR_IRQS
) || (new_serial
.irq
< 0) ||
681 (new_serial
.baud_base
< 9600))
687 if (change_port
|| change_irq
) {
691 * Make sure that we are the sole user of this port.
693 if (uart_users(state
) > 1)
697 * We need to shutdown the serial port at the old
698 * port/type/irq combination.
700 uart_shutdown(state
);
704 unsigned long old_iobase
, old_mapbase
;
705 unsigned int old_type
, old_iotype
, old_hub6
, old_shift
;
707 old_iobase
= port
->iobase
;
708 old_mapbase
= port
->mapbase
;
709 old_type
= port
->type
;
710 old_hub6
= port
->hub6
;
711 old_iotype
= port
->iotype
;
712 old_shift
= port
->regshift
;
715 * Free and release old regions
717 if (old_type
!= PORT_UNKNOWN
)
718 port
->ops
->release_port(port
);
720 port
->iobase
= new_port
;
721 port
->type
= new_serial
.type
;
722 port
->hub6
= new_serial
.hub6
;
723 port
->iotype
= new_serial
.io_type
;
724 port
->regshift
= new_serial
.iomem_reg_shift
;
725 port
->mapbase
= (unsigned long)new_serial
.iomem_base
;
728 * Claim and map the new regions
730 if (port
->type
!= PORT_UNKNOWN
) {
731 retval
= port
->ops
->request_port(port
);
733 /* Always success - Jean II */
738 * If we fail to request resources for the
739 * new port, try to restore the old settings.
741 if (retval
&& old_type
!= PORT_UNKNOWN
) {
742 port
->iobase
= old_iobase
;
743 port
->type
= old_type
;
744 port
->hub6
= old_hub6
;
745 port
->iotype
= old_iotype
;
746 port
->regshift
= old_shift
;
747 port
->mapbase
= old_mapbase
;
748 retval
= port
->ops
->request_port(port
);
750 * If we failed to restore the old settings,
754 port
->type
= PORT_UNKNOWN
;
763 port
->irq
= new_serial
.irq
;
764 port
->uartclk
= new_serial
.baud_base
* 16;
765 port
->flags
= (port
->flags
& ~UPF_CHANGE_MASK
) |
766 (new_serial
.flags
& UPF_CHANGE_MASK
);
767 port
->custom_divisor
= new_serial
.custom_divisor
;
768 state
->close_delay
= close_delay
;
769 state
->closing_wait
= closing_wait
;
770 port
->fifosize
= new_serial
.xmit_fifo_size
;
771 if (state
->info
->tty
)
772 state
->info
->tty
->low_latency
=
773 (port
->flags
& UPF_LOW_LATENCY
) ? 1 : 0;
777 if (port
->type
== PORT_UNKNOWN
)
779 if (state
->info
->flags
& UIF_INITIALIZED
) {
780 if (((old_flags
^ port
->flags
) & UPF_SPD_MASK
) ||
781 old_custom_divisor
!= port
->custom_divisor
) {
783 * If they're setting up a custom divisor or speed,
784 * instead of clearing it, then bitch about it. No
785 * need to rate-limit; it's CAP_SYS_ADMIN only.
787 if (port
->flags
& UPF_SPD_MASK
) {
790 "%s sets custom speed on %s. This "
791 "is deprecated.\n", current
->comm
,
792 tty_name(state
->info
->tty
, buf
));
794 uart_change_speed(state
, NULL
);
797 retval
= uart_startup(state
, 1);
805 * uart_get_lsr_info - get line status register info.
806 * Note: uart_ioctl protects us against hangups.
808 static int uart_get_lsr_info(struct uart_state
*state
,
809 unsigned int __user
*value
)
811 struct uart_port
*port
= state
->port
;
814 result
= port
->ops
->tx_empty(port
);
817 * If we're about to load something into the transmit
818 * register, we'll pretend the transmitter isn't empty to
819 * avoid a race condition (depending on when the transmit
820 * interrupt happens).
823 ((uart_circ_chars_pending(&state
->info
->xmit
) > 0) &&
824 !state
->info
->tty
->stopped
&& !state
->info
->tty
->hw_stopped
))
825 result
&= ~TIOCSER_TEMT
;
827 return put_user(result
, value
);
830 static int uart_tiocmget(struct tty_struct
*tty
, struct file
*file
)
832 struct uart_state
*state
= tty
->driver_data
;
833 struct uart_port
*port
= state
->port
;
837 if ((!file
|| !tty_hung_up_p(file
)) &&
838 !(tty
->flags
& (1 << TTY_IO_ERROR
))) {
839 result
= port
->mctrl
;
841 spin_lock_irq(&port
->lock
);
842 result
|= port
->ops
->get_mctrl(port
);
843 spin_unlock_irq(&port
->lock
);
851 uart_tiocmset(struct tty_struct
*tty
, struct file
*file
,
852 unsigned int set
, unsigned int clear
)
854 struct uart_state
*state
= tty
->driver_data
;
855 struct uart_port
*port
= state
->port
;
859 if ((!file
|| !tty_hung_up_p(file
)) &&
860 !(tty
->flags
& (1 << TTY_IO_ERROR
))) {
861 uart_update_mctrl(port
, set
, clear
);
868 static void uart_break_ctl(struct tty_struct
*tty
, int break_state
)
870 struct uart_state
*state
= tty
->driver_data
;
871 struct uart_port
*port
= state
->port
;
873 BUG_ON(!kernel_locked());
877 if (port
->type
!= PORT_UNKNOWN
)
878 port
->ops
->break_ctl(port
, break_state
);
883 static int uart_do_autoconfig(struct uart_state
*state
)
885 struct uart_port
*port
= state
->port
;
888 if (!capable(CAP_SYS_ADMIN
))
892 * Take the per-port semaphore. This prevents count from
893 * changing, and hence any extra opens of the port while
894 * we're auto-configuring.
896 if (down_interruptible(&state
->sem
))
900 if (uart_users(state
) == 1) {
901 uart_shutdown(state
);
904 * If we already have a port type configured,
905 * we must release its resources.
907 if (port
->type
!= PORT_UNKNOWN
)
908 port
->ops
->release_port(port
);
910 flags
= UART_CONFIG_TYPE
;
911 if (port
->flags
& UPF_AUTO_IRQ
)
912 flags
|= UART_CONFIG_IRQ
;
915 * This will claim the ports resources if
918 port
->ops
->config_port(port
, flags
);
920 ret
= uart_startup(state
, 1);
927 * Wait for any of the 4 modem inputs (DCD,RI,DSR,CTS) to change
928 * - mask passed in arg for lines of interest
929 * (use |'ed TIOCM_RNG/DSR/CD/CTS for masking)
930 * Caller should use TIOCGICOUNT to see which one it was
933 uart_wait_modem_status(struct uart_state
*state
, unsigned long arg
)
935 struct uart_port
*port
= state
->port
;
936 DECLARE_WAITQUEUE(wait
, current
);
937 struct uart_icount cprev
, cnow
;
941 * note the counters on entry
943 spin_lock_irq(&port
->lock
);
944 memcpy(&cprev
, &port
->icount
, sizeof(struct uart_icount
));
947 * Force modem status interrupts on
949 port
->ops
->enable_ms(port
);
950 spin_unlock_irq(&port
->lock
);
952 add_wait_queue(&state
->info
->delta_msr_wait
, &wait
);
954 spin_lock_irq(&port
->lock
);
955 memcpy(&cnow
, &port
->icount
, sizeof(struct uart_icount
));
956 spin_unlock_irq(&port
->lock
);
958 set_current_state(TASK_INTERRUPTIBLE
);
960 if (((arg
& TIOCM_RNG
) && (cnow
.rng
!= cprev
.rng
)) ||
961 ((arg
& TIOCM_DSR
) && (cnow
.dsr
!= cprev
.dsr
)) ||
962 ((arg
& TIOCM_CD
) && (cnow
.dcd
!= cprev
.dcd
)) ||
963 ((arg
& TIOCM_CTS
) && (cnow
.cts
!= cprev
.cts
))) {
970 /* see if a signal did it */
971 if (signal_pending(current
)) {
979 current
->state
= TASK_RUNNING
;
980 remove_wait_queue(&state
->info
->delta_msr_wait
, &wait
);
986 * Get counter of input serial line interrupts (DCD,RI,DSR,CTS)
987 * Return: write counters to the user passed counter struct
988 * NB: both 1->0 and 0->1 transitions are counted except for
989 * RI where only 0->1 is counted.
991 static int uart_get_count(struct uart_state
*state
,
992 struct serial_icounter_struct __user
*icnt
)
994 struct serial_icounter_struct icount
;
995 struct uart_icount cnow
;
996 struct uart_port
*port
= state
->port
;
998 spin_lock_irq(&port
->lock
);
999 memcpy(&cnow
, &port
->icount
, sizeof(struct uart_icount
));
1000 spin_unlock_irq(&port
->lock
);
1002 icount
.cts
= cnow
.cts
;
1003 icount
.dsr
= cnow
.dsr
;
1004 icount
.rng
= cnow
.rng
;
1005 icount
.dcd
= cnow
.dcd
;
1006 icount
.rx
= cnow
.rx
;
1007 icount
.tx
= cnow
.tx
;
1008 icount
.frame
= cnow
.frame
;
1009 icount
.overrun
= cnow
.overrun
;
1010 icount
.parity
= cnow
.parity
;
1011 icount
.brk
= cnow
.brk
;
1012 icount
.buf_overrun
= cnow
.buf_overrun
;
1014 return copy_to_user(icnt
, &icount
, sizeof(icount
)) ? -EFAULT
: 0;
1018 * Called via sys_ioctl under the BKL. We can use spin_lock_irq() here.
1021 uart_ioctl(struct tty_struct
*tty
, struct file
*filp
, unsigned int cmd
,
1024 struct uart_state
*state
= tty
->driver_data
;
1025 void __user
*uarg
= (void __user
*)arg
;
1026 int ret
= -ENOIOCTLCMD
;
1028 BUG_ON(!kernel_locked());
1031 * These ioctls don't rely on the hardware to be present.
1035 ret
= uart_get_info(state
, uarg
);
1039 ret
= uart_set_info(state
, uarg
);
1043 ret
= uart_do_autoconfig(state
);
1046 case TIOCSERGWILD
: /* obsolete */
1047 case TIOCSERSWILD
: /* obsolete */
1052 if (ret
!= -ENOIOCTLCMD
)
1055 if (tty
->flags
& (1 << TTY_IO_ERROR
)) {
1061 * The following should only be used when hardware is present.
1065 ret
= uart_wait_modem_status(state
, arg
);
1069 ret
= uart_get_count(state
, uarg
);
1073 if (ret
!= -ENOIOCTLCMD
)
1078 if (tty_hung_up_p(filp
)) {
1084 * All these rely on hardware being present and need to be
1085 * protected against the tty being hung up.
1088 case TIOCSERGETLSR
: /* Get line status register */
1089 ret
= uart_get_lsr_info(state
, uarg
);
1093 struct uart_port
*port
= state
->port
;
1094 if (port
->ops
->ioctl
)
1095 ret
= port
->ops
->ioctl(port
, cmd
, arg
);
1105 static void uart_set_termios(struct tty_struct
*tty
, struct termios
*old_termios
)
1107 struct uart_state
*state
= tty
->driver_data
;
1108 unsigned long flags
;
1109 unsigned int cflag
= tty
->termios
->c_cflag
;
1111 BUG_ON(!kernel_locked());
1114 * These are the bits that are used to setup various
1115 * flags in the low level driver.
1117 #define RELEVANT_IFLAG(iflag) ((iflag) & (IGNBRK|BRKINT|IGNPAR|PARMRK|INPCK))
1119 if ((cflag
^ old_termios
->c_cflag
) == 0 &&
1120 RELEVANT_IFLAG(tty
->termios
->c_iflag
^ old_termios
->c_iflag
) == 0)
1123 uart_change_speed(state
, old_termios
);
1125 /* Handle transition to B0 status */
1126 if ((old_termios
->c_cflag
& CBAUD
) && !(cflag
& CBAUD
))
1127 uart_clear_mctrl(state
->port
, TIOCM_RTS
| TIOCM_DTR
);
1129 /* Handle transition away from B0 status */
1130 if (!(old_termios
->c_cflag
& CBAUD
) && (cflag
& CBAUD
)) {
1131 unsigned int mask
= TIOCM_DTR
;
1132 if (!(cflag
& CRTSCTS
) ||
1133 !test_bit(TTY_THROTTLED
, &tty
->flags
))
1135 uart_set_mctrl(state
->port
, mask
);
1138 /* Handle turning off CRTSCTS */
1139 if ((old_termios
->c_cflag
& CRTSCTS
) && !(cflag
& CRTSCTS
)) {
1140 spin_lock_irqsave(&state
->port
->lock
, flags
);
1141 tty
->hw_stopped
= 0;
1143 spin_unlock_irqrestore(&state
->port
->lock
, flags
);
1146 /* Handle turning on CRTSCTS */
1147 if (!(old_termios
->c_cflag
& CRTSCTS
) && (cflag
& CRTSCTS
)) {
1148 spin_lock_irqsave(&state
->port
->lock
, flags
);
1149 if (!(state
->port
->ops
->get_mctrl(state
->port
) & TIOCM_CTS
)) {
1150 tty
->hw_stopped
= 1;
1151 state
->port
->ops
->stop_tx(state
->port
);
1153 spin_unlock_irqrestore(&state
->port
->lock
, flags
);
1158 * No need to wake up processes in open wait, since they
1159 * sample the CLOCAL flag once, and don't recheck it.
1160 * XXX It's not clear whether the current behavior is correct
1161 * or not. Hence, this may change.....
1163 if (!(old_termios
->c_cflag
& CLOCAL
) &&
1164 (tty
->termios
->c_cflag
& CLOCAL
))
1165 wake_up_interruptible(&state
->info
->open_wait
);
1170 * In 2.4.5, calls to this will be serialized via the BKL in
1171 * linux/drivers/char/tty_io.c:tty_release()
1172 * linux/drivers/char/tty_io.c:do_tty_handup()
1174 static void uart_close(struct tty_struct
*tty
, struct file
*filp
)
1176 struct uart_state
*state
= tty
->driver_data
;
1177 struct uart_port
*port
;
1179 BUG_ON(!kernel_locked());
1181 if (!state
|| !state
->port
)
1186 DPRINTK("uart_close(%d) called\n", port
->line
);
1190 if (tty_hung_up_p(filp
))
1193 if ((tty
->count
== 1) && (state
->count
!= 1)) {
1195 * Uh, oh. tty->count is 1, which means that the tty
1196 * structure will be freed. state->count should always
1197 * be one in these conditions. If it's greater than
1198 * one, we've got real problems, since it means the
1199 * serial port won't be shutdown.
1201 printk(KERN_ERR
"uart_close: bad serial port count; tty->count is 1, "
1202 "state->count is %d\n", state
->count
);
1205 if (--state
->count
< 0) {
1206 printk(KERN_ERR
"uart_close: bad serial port count for %s: %d\n",
1207 tty
->name
, state
->count
);
1214 * Now we wait for the transmit buffer to clear; and we notify
1215 * the line discipline to only process XON/XOFF characters by
1216 * setting tty->closing.
1220 if (state
->closing_wait
!= USF_CLOSING_WAIT_NONE
)
1221 tty_wait_until_sent(tty
, msecs_to_jiffies(state
->closing_wait
));
1224 * At this point, we stop accepting input. To do this, we
1225 * disable the receive line status interrupts.
1227 if (state
->info
->flags
& UIF_INITIALIZED
) {
1228 unsigned long flags
;
1229 spin_lock_irqsave(&port
->lock
, flags
);
1230 port
->ops
->stop_rx(port
);
1231 spin_unlock_irqrestore(&port
->lock
, flags
);
1233 * Before we drop DTR, make sure the UART transmitter
1234 * has completely drained; this is especially
1235 * important if there is a transmit FIFO!
1237 uart_wait_until_sent(tty
, port
->timeout
);
1240 uart_shutdown(state
);
1241 uart_flush_buffer(tty
);
1243 tty_ldisc_flush(tty
);
1246 state
->info
->tty
= NULL
;
1248 if (state
->info
->blocked_open
) {
1249 if (state
->close_delay
)
1250 msleep_interruptible(state
->close_delay
);
1251 } else if (!uart_console(port
)) {
1252 uart_change_pm(state
, 3);
1256 * Wake up anyone trying to open this port.
1258 state
->info
->flags
&= ~UIF_NORMAL_ACTIVE
;
1259 wake_up_interruptible(&state
->info
->open_wait
);
1265 static void uart_wait_until_sent(struct tty_struct
*tty
, int timeout
)
1267 struct uart_state
*state
= tty
->driver_data
;
1268 struct uart_port
*port
= state
->port
;
1269 unsigned long char_time
, expire
;
1271 BUG_ON(!kernel_locked());
1273 if (port
->type
== PORT_UNKNOWN
|| port
->fifosize
== 0)
1277 * Set the check interval to be 1/5 of the estimated time to
1278 * send a single character, and make it at least 1. The check
1279 * interval should also be less than the timeout.
1281 * Note: we have to use pretty tight timings here to satisfy
1284 char_time
= (port
->timeout
- HZ
/50) / port
->fifosize
;
1285 char_time
= char_time
/ 5;
1288 if (timeout
&& timeout
< char_time
)
1289 char_time
= timeout
;
1292 * If the transmitter hasn't cleared in twice the approximate
1293 * amount of time to send the entire FIFO, it probably won't
1294 * ever clear. This assumes the UART isn't doing flow
1295 * control, which is currently the case. Hence, if it ever
1296 * takes longer than port->timeout, this is probably due to a
1297 * UART bug of some kind. So, we clamp the timeout parameter at
1300 if (timeout
== 0 || timeout
> 2 * port
->timeout
)
1301 timeout
= 2 * port
->timeout
;
1303 expire
= jiffies
+ timeout
;
1305 DPRINTK("uart_wait_until_sent(%d), jiffies=%lu, expire=%lu...\n",
1306 port
->line
, jiffies
, expire
);
1309 * Check whether the transmitter is empty every 'char_time'.
1310 * 'timeout' / 'expire' give us the maximum amount of time
1313 while (!port
->ops
->tx_empty(port
)) {
1314 msleep_interruptible(jiffies_to_msecs(char_time
));
1315 if (signal_pending(current
))
1317 if (time_after(jiffies
, expire
))
1320 set_current_state(TASK_RUNNING
); /* might not be needed */
1324 * This is called with the BKL held in
1325 * linux/drivers/char/tty_io.c:do_tty_hangup()
1326 * We're called from the eventd thread, so we can sleep for
1327 * a _short_ time only.
1329 static void uart_hangup(struct tty_struct
*tty
)
1331 struct uart_state
*state
= tty
->driver_data
;
1333 BUG_ON(!kernel_locked());
1334 DPRINTK("uart_hangup(%d)\n", state
->port
->line
);
1337 if (state
->info
&& state
->info
->flags
& UIF_NORMAL_ACTIVE
) {
1338 uart_flush_buffer(tty
);
1339 uart_shutdown(state
);
1341 state
->info
->flags
&= ~UIF_NORMAL_ACTIVE
;
1342 state
->info
->tty
= NULL
;
1343 wake_up_interruptible(&state
->info
->open_wait
);
1344 wake_up_interruptible(&state
->info
->delta_msr_wait
);
1350 * Copy across the serial console cflag setting into the termios settings
1351 * for the initial open of the port. This allows continuity between the
1352 * kernel settings, and the settings init adopts when it opens the port
1353 * for the first time.
1355 static void uart_update_termios(struct uart_state
*state
)
1357 struct tty_struct
*tty
= state
->info
->tty
;
1358 struct uart_port
*port
= state
->port
;
1360 if (uart_console(port
) && port
->cons
->cflag
) {
1361 tty
->termios
->c_cflag
= port
->cons
->cflag
;
1362 port
->cons
->cflag
= 0;
1366 * If the device failed to grab its irq resources,
1367 * or some other error occurred, don't try to talk
1368 * to the port hardware.
1370 if (!(tty
->flags
& (1 << TTY_IO_ERROR
))) {
1372 * Make termios settings take effect.
1374 uart_change_speed(state
, NULL
);
1377 * And finally enable the RTS and DTR signals.
1379 if (tty
->termios
->c_cflag
& CBAUD
)
1380 uart_set_mctrl(port
, TIOCM_DTR
| TIOCM_RTS
);
1385 * Block the open until the port is ready. We must be called with
1386 * the per-port semaphore held.
1389 uart_block_til_ready(struct file
*filp
, struct uart_state
*state
)
1391 DECLARE_WAITQUEUE(wait
, current
);
1392 struct uart_info
*info
= state
->info
;
1393 struct uart_port
*port
= state
->port
;
1396 info
->blocked_open
++;
1399 add_wait_queue(&info
->open_wait
, &wait
);
1401 set_current_state(TASK_INTERRUPTIBLE
);
1404 * If we have been hung up, tell userspace/restart open.
1406 if (tty_hung_up_p(filp
) || info
->tty
== NULL
)
1410 * If the port has been closed, tell userspace/restart open.
1412 if (!(info
->flags
& UIF_INITIALIZED
))
1416 * If non-blocking mode is set, or CLOCAL mode is set,
1417 * we don't want to wait for the modem status lines to
1418 * indicate that the port is ready.
1420 * Also, if the port is not enabled/configured, we want
1421 * to allow the open to succeed here. Note that we will
1422 * have set TTY_IO_ERROR for a non-existant port.
1424 if ((filp
->f_flags
& O_NONBLOCK
) ||
1425 (info
->tty
->termios
->c_cflag
& CLOCAL
) ||
1426 (info
->tty
->flags
& (1 << TTY_IO_ERROR
))) {
1431 * Set DTR to allow modem to know we're waiting. Do
1432 * not set RTS here - we want to make sure we catch
1433 * the data from the modem.
1435 if (info
->tty
->termios
->c_cflag
& CBAUD
)
1436 uart_set_mctrl(port
, TIOCM_DTR
);
1439 * and wait for the carrier to indicate that the
1440 * modem is ready for us.
1442 spin_lock_irq(&port
->lock
);
1443 mctrl
= port
->ops
->get_mctrl(port
);
1444 spin_unlock_irq(&port
->lock
);
1445 if (mctrl
& TIOCM_CAR
)
1452 if (signal_pending(current
))
1455 set_current_state(TASK_RUNNING
);
1456 remove_wait_queue(&info
->open_wait
, &wait
);
1459 info
->blocked_open
--;
1461 if (signal_pending(current
))
1462 return -ERESTARTSYS
;
1464 if (!info
->tty
|| tty_hung_up_p(filp
))
1470 static struct uart_state
*uart_get(struct uart_driver
*drv
, int line
)
1472 struct uart_state
*state
;
1475 state
= drv
->state
+ line
;
1476 if (down_interruptible(&state
->sem
)) {
1477 state
= ERR_PTR(-ERESTARTSYS
);
1485 state
= ERR_PTR(-ENXIO
);
1490 state
->info
= kmalloc(sizeof(struct uart_info
), GFP_KERNEL
);
1492 memset(state
->info
, 0, sizeof(struct uart_info
));
1493 init_waitqueue_head(&state
->info
->open_wait
);
1494 init_waitqueue_head(&state
->info
->delta_msr_wait
);
1497 * Link the info into the other structures.
1499 state
->port
->info
= state
->info
;
1501 tasklet_init(&state
->info
->tlet
, uart_tasklet_action
,
1502 (unsigned long)state
);
1506 state
= ERR_PTR(-ENOMEM
);
1516 * In 2.4.5, calls to uart_open are serialised by the BKL in
1517 * linux/fs/devices.c:chrdev_open()
1518 * Note that if this fails, then uart_close() _will_ be called.
1520 * In time, we want to scrap the "opening nonpresent ports"
1521 * behaviour and implement an alternative way for setserial
1522 * to set base addresses/ports/types. This will allow us to
1523 * get rid of a certain amount of extra tests.
1525 static int uart_open(struct tty_struct
*tty
, struct file
*filp
)
1527 struct uart_driver
*drv
= (struct uart_driver
*)tty
->driver
->driver_state
;
1528 struct uart_state
*state
;
1529 int retval
, line
= tty
->index
;
1531 BUG_ON(!kernel_locked());
1532 DPRINTK("uart_open(%d) called\n", line
);
1535 * tty->driver->num won't change, so we won't fail here with
1536 * tty->driver_data set to something non-NULL (and therefore
1537 * we won't get caught by uart_close()).
1540 if (line
>= tty
->driver
->num
)
1544 * We take the semaphore inside uart_get to guarantee that we won't
1545 * be re-entered while allocating the info structure, or while we
1546 * request any IRQs that the driver may need. This also has the nice
1547 * side-effect that it delays the action of uart_hangup, so we can
1548 * guarantee that info->tty will always contain something reasonable.
1550 state
= uart_get(drv
, line
);
1551 if (IS_ERR(state
)) {
1552 retval
= PTR_ERR(state
);
1557 * Once we set tty->driver_data here, we are guaranteed that
1558 * uart_close() will decrement the driver module use count.
1559 * Any failures from here onwards should not touch the count.
1561 tty
->driver_data
= state
;
1562 tty
->low_latency
= (state
->port
->flags
& UPF_LOW_LATENCY
) ? 1 : 0;
1564 state
->info
->tty
= tty
;
1567 * If the port is in the middle of closing, bail out now.
1569 if (tty_hung_up_p(filp
)) {
1577 * Make sure the device is in D0 state.
1579 if (state
->count
== 1)
1580 uart_change_pm(state
, 0);
1583 * Start up the serial port.
1585 retval
= uart_startup(state
, 0);
1588 * If we succeeded, wait until the port is ready.
1591 retval
= uart_block_til_ready(filp
, state
);
1595 * If this is the first open to succeed, adjust things to suit.
1597 if (retval
== 0 && !(state
->info
->flags
& UIF_NORMAL_ACTIVE
)) {
1598 state
->info
->flags
|= UIF_NORMAL_ACTIVE
;
1600 uart_update_termios(state
);
1607 static const char *uart_type(struct uart_port
*port
)
1609 const char *str
= NULL
;
1611 if (port
->ops
->type
)
1612 str
= port
->ops
->type(port
);
1620 #ifdef CONFIG_PROC_FS
1622 static int uart_line_info(char *buf
, struct uart_driver
*drv
, int i
)
1624 struct uart_state
*state
= drv
->state
+ i
;
1625 struct uart_port
*port
= state
->port
;
1627 unsigned int status
;
1633 ret
= sprintf(buf
, "%d: uart:%s %s%08lX irq:%d",
1634 port
->line
, uart_type(port
),
1635 port
->iotype
== UPIO_MEM
? "mmio:0x" : "port:",
1636 port
->iotype
== UPIO_MEM
? port
->mapbase
:
1637 (unsigned long) port
->iobase
,
1640 if (port
->type
== PORT_UNKNOWN
) {
1645 if(capable(CAP_SYS_ADMIN
))
1647 spin_lock_irq(&port
->lock
);
1648 status
= port
->ops
->get_mctrl(port
);
1649 spin_unlock_irq(&port
->lock
);
1651 ret
+= sprintf(buf
+ ret
, " tx:%d rx:%d",
1652 port
->icount
.tx
, port
->icount
.rx
);
1653 if (port
->icount
.frame
)
1654 ret
+= sprintf(buf
+ ret
, " fe:%d",
1655 port
->icount
.frame
);
1656 if (port
->icount
.parity
)
1657 ret
+= sprintf(buf
+ ret
, " pe:%d",
1658 port
->icount
.parity
);
1659 if (port
->icount
.brk
)
1660 ret
+= sprintf(buf
+ ret
, " brk:%d",
1662 if (port
->icount
.overrun
)
1663 ret
+= sprintf(buf
+ ret
, " oe:%d",
1664 port
->icount
.overrun
);
1666 #define INFOBIT(bit,str) \
1667 if (port->mctrl & (bit)) \
1668 strncat(stat_buf, (str), sizeof(stat_buf) - \
1669 strlen(stat_buf) - 2)
1670 #define STATBIT(bit,str) \
1671 if (status & (bit)) \
1672 strncat(stat_buf, (str), sizeof(stat_buf) - \
1673 strlen(stat_buf) - 2)
1677 INFOBIT(TIOCM_RTS
, "|RTS");
1678 STATBIT(TIOCM_CTS
, "|CTS");
1679 INFOBIT(TIOCM_DTR
, "|DTR");
1680 STATBIT(TIOCM_DSR
, "|DSR");
1681 STATBIT(TIOCM_CAR
, "|CD");
1682 STATBIT(TIOCM_RNG
, "|RI");
1685 strcat(stat_buf
, "\n");
1687 ret
+= sprintf(buf
+ ret
, stat_buf
);
1697 static int uart_read_proc(char *page
, char **start
, off_t off
,
1698 int count
, int *eof
, void *data
)
1700 struct tty_driver
*ttydrv
= data
;
1701 struct uart_driver
*drv
= ttydrv
->driver_state
;
1705 len
+= sprintf(page
, "serinfo:1.0 driver%s%s revision:%s\n",
1707 for (i
= 0; i
< drv
->nr
&& len
< PAGE_SIZE
- 96; i
++) {
1708 l
= uart_line_info(page
+ len
, drv
, i
);
1710 if (len
+ begin
> off
+ count
)
1712 if (len
+ begin
< off
) {
1719 if (off
>= len
+ begin
)
1721 *start
= page
+ (off
- begin
);
1722 return (count
< begin
+ len
- off
) ? count
: (begin
+ len
- off
);
1726 #ifdef CONFIG_SERIAL_CORE_CONSOLE
1728 * Check whether an invalid uart number has been specified, and
1729 * if so, search for the first available port that does have
1732 struct uart_port
* __init
1733 uart_get_console(struct uart_port
*ports
, int nr
, struct console
*co
)
1735 int idx
= co
->index
;
1737 if (idx
< 0 || idx
>= nr
|| (ports
[idx
].iobase
== 0 &&
1738 ports
[idx
].membase
== NULL
))
1739 for (idx
= 0; idx
< nr
; idx
++)
1740 if (ports
[idx
].iobase
!= 0 ||
1741 ports
[idx
].membase
!= NULL
)
1750 * uart_parse_options - Parse serial port baud/parity/bits/flow contro.
1751 * @options: pointer to option string
1752 * @baud: pointer to an 'int' variable for the baud rate.
1753 * @parity: pointer to an 'int' variable for the parity.
1754 * @bits: pointer to an 'int' variable for the number of data bits.
1755 * @flow: pointer to an 'int' variable for the flow control character.
1757 * uart_parse_options decodes a string containing the serial console
1758 * options. The format of the string is <baud><parity><bits><flow>,
1762 uart_parse_options(char *options
, int *baud
, int *parity
, int *bits
, int *flow
)
1766 *baud
= simple_strtoul(s
, NULL
, 10);
1767 while (*s
>= '0' && *s
<= '9')
1782 static const struct baud_rates baud_rates
[] = {
1783 { 921600, B921600
},
1784 { 460800, B460800
},
1785 { 230400, B230400
},
1786 { 115200, B115200
},
1798 * uart_set_options - setup the serial console parameters
1799 * @port: pointer to the serial ports uart_port structure
1800 * @co: console pointer
1802 * @parity: parity character - 'n' (none), 'o' (odd), 'e' (even)
1803 * @bits: number of data bits
1804 * @flow: flow control character - 'r' (rts)
1807 uart_set_options(struct uart_port
*port
, struct console
*co
,
1808 int baud
, int parity
, int bits
, int flow
)
1810 struct termios termios
;
1814 * Ensure that the serial console lock is initialised
1817 spin_lock_init(&port
->lock
);
1819 memset(&termios
, 0, sizeof(struct termios
));
1821 termios
.c_cflag
= CREAD
| HUPCL
| CLOCAL
;
1824 * Construct a cflag setting.
1826 for (i
= 0; baud_rates
[i
].rate
; i
++)
1827 if (baud_rates
[i
].rate
<= baud
)
1830 termios
.c_cflag
|= baud_rates
[i
].cflag
;
1833 termios
.c_cflag
|= CS7
;
1835 termios
.c_cflag
|= CS8
;
1839 termios
.c_cflag
|= PARODD
;
1842 termios
.c_cflag
|= PARENB
;
1847 termios
.c_cflag
|= CRTSCTS
;
1849 port
->ops
->set_termios(port
, &termios
, NULL
);
1850 co
->cflag
= termios
.c_cflag
;
1854 #endif /* CONFIG_SERIAL_CORE_CONSOLE */
1856 static void uart_change_pm(struct uart_state
*state
, int pm_state
)
1858 struct uart_port
*port
= state
->port
;
1860 port
->ops
->pm(port
, pm_state
, state
->pm_state
);
1861 state
->pm_state
= pm_state
;
1864 int uart_suspend_port(struct uart_driver
*drv
, struct uart_port
*port
)
1866 struct uart_state
*state
= drv
->state
+ port
->line
;
1870 if (state
->info
&& state
->info
->flags
& UIF_INITIALIZED
) {
1871 struct uart_ops
*ops
= port
->ops
;
1873 spin_lock_irq(&port
->lock
);
1875 ops
->set_mctrl(port
, 0);
1877 spin_unlock_irq(&port
->lock
);
1880 * Wait for the transmitter to empty.
1882 while (!ops
->tx_empty(port
)) {
1886 ops
->shutdown(port
);
1890 * Disable the console device before suspending.
1892 if (uart_console(port
))
1893 console_stop(port
->cons
);
1895 uart_change_pm(state
, 3);
1902 int uart_resume_port(struct uart_driver
*drv
, struct uart_port
*port
)
1904 struct uart_state
*state
= drv
->state
+ port
->line
;
1908 uart_change_pm(state
, 0);
1911 * Re-enable the console device after suspending.
1913 if (uart_console(port
)) {
1914 struct termios termios
;
1917 * First try to use the console cflag setting.
1919 memset(&termios
, 0, sizeof(struct termios
));
1920 termios
.c_cflag
= port
->cons
->cflag
;
1923 * If that's unset, use the tty termios setting.
1925 if (state
->info
&& state
->info
->tty
&& termios
.c_cflag
== 0)
1926 termios
= *state
->info
->tty
->termios
;
1928 port
->ops
->set_termios(port
, &termios
, NULL
);
1929 console_start(port
->cons
);
1932 if (state
->info
&& state
->info
->flags
& UIF_INITIALIZED
) {
1933 struct uart_ops
*ops
= port
->ops
;
1936 ops
->set_mctrl(port
, 0);
1937 ret
= ops
->startup(port
);
1939 uart_change_speed(state
, NULL
);
1940 spin_lock_irq(&port
->lock
);
1941 ops
->set_mctrl(port
, port
->mctrl
);
1942 ops
->start_tx(port
);
1943 spin_unlock_irq(&port
->lock
);
1946 * Failed to resume - maybe hardware went away?
1947 * Clear the "initialized" flag so we won't try
1948 * to call the low level drivers shutdown method.
1950 state
->info
->flags
&= ~UIF_INITIALIZED
;
1951 uart_shutdown(state
);
1961 uart_report_port(struct uart_driver
*drv
, struct uart_port
*port
)
1965 switch (port
->iotype
) {
1967 snprintf(address
, sizeof(address
),
1968 "I/O 0x%x", port
->iobase
);
1971 snprintf(address
, sizeof(address
),
1972 "I/O 0x%x offset 0x%x", port
->iobase
, port
->hub6
);
1977 snprintf(address
, sizeof(address
),
1978 "MMIO 0x%lx", port
->mapbase
);
1981 strlcpy(address
, "*unknown*", sizeof(address
));
1985 printk(KERN_INFO
"%s%s%s%d at %s (irq = %d) is a %s\n",
1986 port
->dev
? port
->dev
->bus_id
: "",
1987 port
->dev
? ": " : "",
1988 drv
->dev_name
, port
->line
, address
, port
->irq
, uart_type(port
));
1992 uart_configure_port(struct uart_driver
*drv
, struct uart_state
*state
,
1993 struct uart_port
*port
)
1998 * If there isn't a port here, don't do anything further.
2000 if (!port
->iobase
&& !port
->mapbase
&& !port
->membase
)
2004 * Now do the auto configuration stuff. Note that config_port
2005 * is expected to claim the resources and map the port for us.
2007 flags
= UART_CONFIG_TYPE
;
2008 if (port
->flags
& UPF_AUTO_IRQ
)
2009 flags
|= UART_CONFIG_IRQ
;
2010 if (port
->flags
& UPF_BOOT_AUTOCONF
) {
2011 port
->type
= PORT_UNKNOWN
;
2012 port
->ops
->config_port(port
, flags
);
2015 if (port
->type
!= PORT_UNKNOWN
) {
2016 unsigned long flags
;
2018 uart_report_port(drv
, port
);
2021 * Ensure that the modem control lines are de-activated.
2022 * We probably don't need a spinlock around this, but
2024 spin_lock_irqsave(&port
->lock
, flags
);
2025 port
->ops
->set_mctrl(port
, 0);
2026 spin_unlock_irqrestore(&port
->lock
, flags
);
2029 * Power down all ports by default, except the
2030 * console if we have one.
2032 if (!uart_console(port
))
2033 uart_change_pm(state
, 3);
2038 * This reverses the effects of uart_configure_port, hanging up the
2039 * port before removal.
2042 uart_unconfigure_port(struct uart_driver
*drv
, struct uart_state
*state
)
2044 struct uart_port
*port
= state
->port
;
2045 struct uart_info
*info
= state
->info
;
2047 if (info
&& info
->tty
)
2048 tty_vhangup(info
->tty
);
2055 * Free the port IO and memory resources, if any.
2057 if (port
->type
!= PORT_UNKNOWN
)
2058 port
->ops
->release_port(port
);
2061 * Indicate that there isn't a port here anymore.
2063 port
->type
= PORT_UNKNOWN
;
2066 * Kill the tasklet, and free resources.
2069 tasklet_kill(&info
->tlet
);
2076 static struct tty_operations uart_ops
= {
2078 .close
= uart_close
,
2079 .write
= uart_write
,
2080 .put_char
= uart_put_char
,
2081 .flush_chars
= uart_flush_chars
,
2082 .write_room
= uart_write_room
,
2083 .chars_in_buffer
= uart_chars_in_buffer
,
2084 .flush_buffer
= uart_flush_buffer
,
2085 .ioctl
= uart_ioctl
,
2086 .throttle
= uart_throttle
,
2087 .unthrottle
= uart_unthrottle
,
2088 .send_xchar
= uart_send_xchar
,
2089 .set_termios
= uart_set_termios
,
2091 .start
= uart_start
,
2092 .hangup
= uart_hangup
,
2093 .break_ctl
= uart_break_ctl
,
2094 .wait_until_sent
= uart_wait_until_sent
,
2095 #ifdef CONFIG_PROC_FS
2096 .read_proc
= uart_read_proc
,
2098 .tiocmget
= uart_tiocmget
,
2099 .tiocmset
= uart_tiocmset
,
2103 * uart_register_driver - register a driver with the uart core layer
2104 * @drv: low level driver structure
2106 * Register a uart driver with the core driver. We in turn register
2107 * with the tty layer, and initialise the core driver per-port state.
2109 * We have a proc file in /proc/tty/driver which is named after the
2112 * drv->port should be NULL, and the per-port structures should be
2113 * registered using uart_add_one_port after this call has succeeded.
2115 int uart_register_driver(struct uart_driver
*drv
)
2117 struct tty_driver
*normal
= NULL
;
2123 * Maybe we should be using a slab cache for this, especially if
2124 * we have a large number of ports to handle.
2126 drv
->state
= kmalloc(sizeof(struct uart_state
) * drv
->nr
, GFP_KERNEL
);
2131 memset(drv
->state
, 0, sizeof(struct uart_state
) * drv
->nr
);
2133 normal
= alloc_tty_driver(drv
->nr
);
2137 drv
->tty_driver
= normal
;
2139 normal
->owner
= drv
->owner
;
2140 normal
->driver_name
= drv
->driver_name
;
2141 normal
->devfs_name
= drv
->devfs_name
;
2142 normal
->name
= drv
->dev_name
;
2143 normal
->major
= drv
->major
;
2144 normal
->minor_start
= drv
->minor
;
2145 normal
->type
= TTY_DRIVER_TYPE_SERIAL
;
2146 normal
->subtype
= SERIAL_TYPE_NORMAL
;
2147 normal
->init_termios
= tty_std_termios
;
2148 normal
->init_termios
.c_cflag
= B9600
| CS8
| CREAD
| HUPCL
| CLOCAL
;
2149 normal
->flags
= TTY_DRIVER_REAL_RAW
| TTY_DRIVER_NO_DEVFS
;
2150 normal
->driver_state
= drv
;
2151 tty_set_operations(normal
, &uart_ops
);
2154 * Initialise the UART state(s).
2156 for (i
= 0; i
< drv
->nr
; i
++) {
2157 struct uart_state
*state
= drv
->state
+ i
;
2159 state
->close_delay
= 500; /* .5 seconds */
2160 state
->closing_wait
= 30000; /* 30 seconds */
2162 init_MUTEX(&state
->sem
);
2165 retval
= tty_register_driver(normal
);
2168 put_tty_driver(normal
);
2175 * uart_unregister_driver - remove a driver from the uart core layer
2176 * @drv: low level driver structure
2178 * Remove all references to a driver from the core driver. The low
2179 * level driver must have removed all its ports via the
2180 * uart_remove_one_port() if it registered them with uart_add_one_port().
2181 * (ie, drv->port == NULL)
2183 void uart_unregister_driver(struct uart_driver
*drv
)
2185 struct tty_driver
*p
= drv
->tty_driver
;
2186 tty_unregister_driver(p
);
2189 drv
->tty_driver
= NULL
;
2192 struct tty_driver
*uart_console_device(struct console
*co
, int *index
)
2194 struct uart_driver
*p
= co
->data
;
2196 return p
->tty_driver
;
2200 * uart_add_one_port - attach a driver-defined port structure
2201 * @drv: pointer to the uart low level driver structure for this port
2202 * @port: uart port structure to use for this port.
2204 * This allows the driver to register its own uart_port structure
2205 * with the core driver. The main purpose is to allow the low
2206 * level uart drivers to expand uart_port, rather than having yet
2207 * more levels of structures.
2209 int uart_add_one_port(struct uart_driver
*drv
, struct uart_port
*port
)
2211 struct uart_state
*state
;
2214 BUG_ON(in_interrupt());
2216 if (port
->line
>= drv
->nr
)
2219 state
= drv
->state
+ port
->line
;
2229 port
->cons
= drv
->cons
;
2230 port
->info
= state
->info
;
2233 * If this port is a console, then the spinlock is already
2236 if (!uart_console(port
))
2237 spin_lock_init(&port
->lock
);
2239 uart_configure_port(drv
, state
, port
);
2242 * Register the port whether it's detected or not. This allows
2243 * setserial to be used to alter this ports parameters.
2245 tty_register_device(drv
->tty_driver
, port
->line
, port
->dev
);
2248 * If this driver supports console, and it hasn't been
2249 * successfully registered yet, try to re-register it.
2250 * It may be that the port was not available.
2252 if (port
->type
!= PORT_UNKNOWN
&&
2253 port
->cons
&& !(port
->cons
->flags
& CON_ENABLED
))
2254 register_console(port
->cons
);
2263 * uart_remove_one_port - detach a driver defined port structure
2264 * @drv: pointer to the uart low level driver structure for this port
2265 * @port: uart port structure for this port
2267 * This unhooks (and hangs up) the specified port structure from the
2268 * core driver. No further calls will be made to the low-level code
2271 int uart_remove_one_port(struct uart_driver
*drv
, struct uart_port
*port
)
2273 struct uart_state
*state
= drv
->state
+ port
->line
;
2275 BUG_ON(in_interrupt());
2277 if (state
->port
!= port
)
2278 printk(KERN_ALERT
"Removing wrong port: %p != %p\n",
2284 * Remove the devices from devfs
2286 tty_unregister_device(drv
->tty_driver
, port
->line
);
2288 uart_unconfigure_port(drv
, state
);
2296 * Are the two ports equivalent?
2298 int uart_match_port(struct uart_port
*port1
, struct uart_port
*port2
)
2300 if (port1
->iotype
!= port2
->iotype
)
2303 switch (port1
->iotype
) {
2305 return (port1
->iobase
== port2
->iobase
);
2307 return (port1
->iobase
== port2
->iobase
) &&
2308 (port1
->hub6
== port2
->hub6
);
2310 return (port1
->mapbase
== port2
->mapbase
);
2314 EXPORT_SYMBOL(uart_match_port
);
2316 EXPORT_SYMBOL(uart_write_wakeup
);
2317 EXPORT_SYMBOL(uart_register_driver
);
2318 EXPORT_SYMBOL(uart_unregister_driver
);
2319 EXPORT_SYMBOL(uart_suspend_port
);
2320 EXPORT_SYMBOL(uart_resume_port
);
2321 EXPORT_SYMBOL(uart_add_one_port
);
2322 EXPORT_SYMBOL(uart_remove_one_port
);
2324 MODULE_DESCRIPTION("Serial driver core");
2325 MODULE_LICENSE("GPL");