xref: /openbmc/linux/drivers/tty/serial/serial_core.c (revision abfbd895)
1 /*
2  *  Driver core for serial ports
3  *
4  *  Based on drivers/char/serial.c, by Linus Torvalds, Theodore Ts'o.
5  *
6  *  Copyright 1999 ARM Limited
7  *  Copyright (C) 2000-2001 Deep Blue Solutions Ltd.
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
22  */
23 #include <linux/module.h>
24 #include <linux/tty.h>
25 #include <linux/tty_flip.h>
26 #include <linux/slab.h>
27 #include <linux/init.h>
28 #include <linux/console.h>
29 #include <linux/of.h>
30 #include <linux/proc_fs.h>
31 #include <linux/seq_file.h>
32 #include <linux/device.h>
33 #include <linux/serial.h> /* for serial_state and serial_icounter_struct */
34 #include <linux/serial_core.h>
35 #include <linux/delay.h>
36 #include <linux/mutex.h>
37 
38 #include <asm/irq.h>
39 #include <asm/uaccess.h>
40 
41 /*
42  * This is used to lock changes in serial line configuration.
43  */
44 static DEFINE_MUTEX(port_mutex);
45 
46 /*
47  * lockdep: port->lock is initialized in two places, but we
48  *          want only one lock-class:
49  */
50 static struct lock_class_key port_lock_key;
51 
52 #define HIGH_BITS_OFFSET	((sizeof(long)-sizeof(int))*8)
53 
54 static void uart_change_speed(struct tty_struct *tty, struct uart_state *state,
55 					struct ktermios *old_termios);
56 static void uart_wait_until_sent(struct tty_struct *tty, int timeout);
57 static void uart_change_pm(struct uart_state *state,
58 			   enum uart_pm_state pm_state);
59 
60 static void uart_port_shutdown(struct tty_port *port);
61 
62 static int uart_dcd_enabled(struct uart_port *uport)
63 {
64 	return !!(uport->status & UPSTAT_DCD_ENABLE);
65 }
66 
67 /*
68  * This routine is used by the interrupt handler to schedule processing in
69  * the software interrupt portion of the driver.
70  */
71 void uart_write_wakeup(struct uart_port *port)
72 {
73 	struct uart_state *state = port->state;
74 	/*
75 	 * This means you called this function _after_ the port was
76 	 * closed.  No cookie for you.
77 	 */
78 	BUG_ON(!state);
79 	tty_wakeup(state->port.tty);
80 }
81 
82 static void uart_stop(struct tty_struct *tty)
83 {
84 	struct uart_state *state = tty->driver_data;
85 	struct uart_port *port = state->uart_port;
86 	unsigned long flags;
87 
88 	spin_lock_irqsave(&port->lock, flags);
89 	port->ops->stop_tx(port);
90 	spin_unlock_irqrestore(&port->lock, flags);
91 }
92 
93 static void __uart_start(struct tty_struct *tty)
94 {
95 	struct uart_state *state = tty->driver_data;
96 	struct uart_port *port = state->uart_port;
97 
98 	if (!uart_tx_stopped(port))
99 		port->ops->start_tx(port);
100 }
101 
102 static void uart_start(struct tty_struct *tty)
103 {
104 	struct uart_state *state = tty->driver_data;
105 	struct uart_port *port = state->uart_port;
106 	unsigned long flags;
107 
108 	spin_lock_irqsave(&port->lock, flags);
109 	__uart_start(tty);
110 	spin_unlock_irqrestore(&port->lock, flags);
111 }
112 
113 static inline void
114 uart_update_mctrl(struct uart_port *port, unsigned int set, unsigned int clear)
115 {
116 	unsigned long flags;
117 	unsigned int old;
118 
119 	spin_lock_irqsave(&port->lock, flags);
120 	old = port->mctrl;
121 	port->mctrl = (old & ~clear) | set;
122 	if (old != port->mctrl)
123 		port->ops->set_mctrl(port, port->mctrl);
124 	spin_unlock_irqrestore(&port->lock, flags);
125 }
126 
127 #define uart_set_mctrl(port, set)	uart_update_mctrl(port, set, 0)
128 #define uart_clear_mctrl(port, clear)	uart_update_mctrl(port, 0, clear)
129 
130 /*
131  * Startup the port.  This will be called once per open.  All calls
132  * will be serialised by the per-port mutex.
133  */
134 static int uart_port_startup(struct tty_struct *tty, struct uart_state *state,
135 		int init_hw)
136 {
137 	struct uart_port *uport = state->uart_port;
138 	unsigned long page;
139 	int retval = 0;
140 
141 	if (uport->type == PORT_UNKNOWN)
142 		return 1;
143 
144 	/*
145 	 * Make sure the device is in D0 state.
146 	 */
147 	uart_change_pm(state, UART_PM_STATE_ON);
148 
149 	/*
150 	 * Initialise and allocate the transmit and temporary
151 	 * buffer.
152 	 */
153 	if (!state->xmit.buf) {
154 		/* This is protected by the per port mutex */
155 		page = get_zeroed_page(GFP_KERNEL);
156 		if (!page)
157 			return -ENOMEM;
158 
159 		state->xmit.buf = (unsigned char *) page;
160 		uart_circ_clear(&state->xmit);
161 	}
162 
163 	retval = uport->ops->startup(uport);
164 	if (retval == 0) {
165 		if (uart_console(uport) && uport->cons->cflag) {
166 			tty->termios.c_cflag = uport->cons->cflag;
167 			uport->cons->cflag = 0;
168 		}
169 		/*
170 		 * Initialise the hardware port settings.
171 		 */
172 		uart_change_speed(tty, state, NULL);
173 
174 		if (init_hw) {
175 			/*
176 			 * Setup the RTS and DTR signals once the
177 			 * port is open and ready to respond.
178 			 */
179 			if (tty->termios.c_cflag & CBAUD)
180 				uart_set_mctrl(uport, TIOCM_RTS | TIOCM_DTR);
181 		}
182 	}
183 
184 	/*
185 	 * This is to allow setserial on this port. People may want to set
186 	 * port/irq/type and then reconfigure the port properly if it failed
187 	 * now.
188 	 */
189 	if (retval && capable(CAP_SYS_ADMIN))
190 		return 1;
191 
192 	return retval;
193 }
194 
195 static int uart_startup(struct tty_struct *tty, struct uart_state *state,
196 		int init_hw)
197 {
198 	struct tty_port *port = &state->port;
199 	int retval;
200 
201 	if (port->flags & ASYNC_INITIALIZED)
202 		return 0;
203 
204 	/*
205 	 * Set the TTY IO error marker - we will only clear this
206 	 * once we have successfully opened the port.
207 	 */
208 	set_bit(TTY_IO_ERROR, &tty->flags);
209 
210 	retval = uart_port_startup(tty, state, init_hw);
211 	if (!retval) {
212 		set_bit(ASYNCB_INITIALIZED, &port->flags);
213 		clear_bit(TTY_IO_ERROR, &tty->flags);
214 	} else if (retval > 0)
215 		retval = 0;
216 
217 	return retval;
218 }
219 
220 /*
221  * This routine will shutdown a serial port; interrupts are disabled, and
222  * DTR is dropped if the hangup on close termio flag is on.  Calls to
223  * uart_shutdown are serialised by the per-port semaphore.
224  */
225 static void uart_shutdown(struct tty_struct *tty, struct uart_state *state)
226 {
227 	struct uart_port *uport = state->uart_port;
228 	struct tty_port *port = &state->port;
229 
230 	/*
231 	 * Set the TTY IO error marker
232 	 */
233 	if (tty)
234 		set_bit(TTY_IO_ERROR, &tty->flags);
235 
236 	if (test_and_clear_bit(ASYNCB_INITIALIZED, &port->flags)) {
237 		/*
238 		 * Turn off DTR and RTS early.
239 		 */
240 		if (uart_console(uport) && tty)
241 			uport->cons->cflag = tty->termios.c_cflag;
242 
243 		if (!tty || (tty->termios.c_cflag & HUPCL))
244 			uart_clear_mctrl(uport, TIOCM_DTR | TIOCM_RTS);
245 
246 		uart_port_shutdown(port);
247 	}
248 
249 	/*
250 	 * It's possible for shutdown to be called after suspend if we get
251 	 * a DCD drop (hangup) at just the right time.  Clear suspended bit so
252 	 * we don't try to resume a port that has been shutdown.
253 	 */
254 	clear_bit(ASYNCB_SUSPENDED, &port->flags);
255 
256 	/*
257 	 * Free the transmit buffer page.
258 	 */
259 	if (state->xmit.buf) {
260 		free_page((unsigned long)state->xmit.buf);
261 		state->xmit.buf = NULL;
262 	}
263 }
264 
265 /**
266  *	uart_update_timeout - update per-port FIFO timeout.
267  *	@port:  uart_port structure describing the port
268  *	@cflag: termios cflag value
269  *	@baud:  speed of the port
270  *
271  *	Set the port FIFO timeout value.  The @cflag value should
272  *	reflect the actual hardware settings.
273  */
274 void
275 uart_update_timeout(struct uart_port *port, unsigned int cflag,
276 		    unsigned int baud)
277 {
278 	unsigned int bits;
279 
280 	/* byte size and parity */
281 	switch (cflag & CSIZE) {
282 	case CS5:
283 		bits = 7;
284 		break;
285 	case CS6:
286 		bits = 8;
287 		break;
288 	case CS7:
289 		bits = 9;
290 		break;
291 	default:
292 		bits = 10;
293 		break; /* CS8 */
294 	}
295 
296 	if (cflag & CSTOPB)
297 		bits++;
298 	if (cflag & PARENB)
299 		bits++;
300 
301 	/*
302 	 * The total number of bits to be transmitted in the fifo.
303 	 */
304 	bits = bits * port->fifosize;
305 
306 	/*
307 	 * Figure the timeout to send the above number of bits.
308 	 * Add .02 seconds of slop
309 	 */
310 	port->timeout = (HZ * bits) / baud + HZ/50;
311 }
312 
313 EXPORT_SYMBOL(uart_update_timeout);
314 
315 /**
316  *	uart_get_baud_rate - return baud rate for a particular port
317  *	@port: uart_port structure describing the port in question.
318  *	@termios: desired termios settings.
319  *	@old: old termios (or NULL)
320  *	@min: minimum acceptable baud rate
321  *	@max: maximum acceptable baud rate
322  *
323  *	Decode the termios structure into a numeric baud rate,
324  *	taking account of the magic 38400 baud rate (with spd_*
325  *	flags), and mapping the %B0 rate to 9600 baud.
326  *
327  *	If the new baud rate is invalid, try the old termios setting.
328  *	If it's still invalid, we try 9600 baud.
329  *
330  *	Update the @termios structure to reflect the baud rate
331  *	we're actually going to be using. Don't do this for the case
332  *	where B0 is requested ("hang up").
333  */
334 unsigned int
335 uart_get_baud_rate(struct uart_port *port, struct ktermios *termios,
336 		   struct ktermios *old, unsigned int min, unsigned int max)
337 {
338 	unsigned int try;
339 	unsigned int baud;
340 	unsigned int altbaud;
341 	int hung_up = 0;
342 	upf_t flags = port->flags & UPF_SPD_MASK;
343 
344 	switch (flags) {
345 	case UPF_SPD_HI:
346 		altbaud = 57600;
347 		break;
348 	case UPF_SPD_VHI:
349 		altbaud = 115200;
350 		break;
351 	case UPF_SPD_SHI:
352 		altbaud = 230400;
353 		break;
354 	case UPF_SPD_WARP:
355 		altbaud = 460800;
356 		break;
357 	default:
358 		altbaud = 38400;
359 		break;
360 	}
361 
362 	for (try = 0; try < 2; try++) {
363 		baud = tty_termios_baud_rate(termios);
364 
365 		/*
366 		 * The spd_hi, spd_vhi, spd_shi, spd_warp kludge...
367 		 * Die! Die! Die!
368 		 */
369 		if (try == 0 && baud == 38400)
370 			baud = altbaud;
371 
372 		/*
373 		 * Special case: B0 rate.
374 		 */
375 		if (baud == 0) {
376 			hung_up = 1;
377 			baud = 9600;
378 		}
379 
380 		if (baud >= min && baud <= max)
381 			return baud;
382 
383 		/*
384 		 * Oops, the quotient was zero.  Try again with
385 		 * the old baud rate if possible.
386 		 */
387 		termios->c_cflag &= ~CBAUD;
388 		if (old) {
389 			baud = tty_termios_baud_rate(old);
390 			if (!hung_up)
391 				tty_termios_encode_baud_rate(termios,
392 								baud, baud);
393 			old = NULL;
394 			continue;
395 		}
396 
397 		/*
398 		 * As a last resort, if the range cannot be met then clip to
399 		 * the nearest chip supported rate.
400 		 */
401 		if (!hung_up) {
402 			if (baud <= min)
403 				tty_termios_encode_baud_rate(termios,
404 							min + 1, min + 1);
405 			else
406 				tty_termios_encode_baud_rate(termios,
407 							max - 1, max - 1);
408 		}
409 	}
410 	/* Should never happen */
411 	WARN_ON(1);
412 	return 0;
413 }
414 
415 EXPORT_SYMBOL(uart_get_baud_rate);
416 
417 /**
418  *	uart_get_divisor - return uart clock divisor
419  *	@port: uart_port structure describing the port.
420  *	@baud: desired baud rate
421  *
422  *	Calculate the uart clock divisor for the port.
423  */
424 unsigned int
425 uart_get_divisor(struct uart_port *port, unsigned int baud)
426 {
427 	unsigned int quot;
428 
429 	/*
430 	 * Old custom speed handling.
431 	 */
432 	if (baud == 38400 && (port->flags & UPF_SPD_MASK) == UPF_SPD_CUST)
433 		quot = port->custom_divisor;
434 	else
435 		quot = DIV_ROUND_CLOSEST(port->uartclk, 16 * baud);
436 
437 	return quot;
438 }
439 
440 EXPORT_SYMBOL(uart_get_divisor);
441 
442 /* Caller holds port mutex */
443 static void uart_change_speed(struct tty_struct *tty, struct uart_state *state,
444 					struct ktermios *old_termios)
445 {
446 	struct uart_port *uport = state->uart_port;
447 	struct ktermios *termios;
448 	int hw_stopped;
449 
450 	/*
451 	 * If we have no tty, termios, or the port does not exist,
452 	 * then we can't set the parameters for this port.
453 	 */
454 	if (!tty || uport->type == PORT_UNKNOWN)
455 		return;
456 
457 	termios = &tty->termios;
458 	uport->ops->set_termios(uport, termios, old_termios);
459 
460 	/*
461 	 * Set modem status enables based on termios cflag
462 	 */
463 	spin_lock_irq(&uport->lock);
464 	if (termios->c_cflag & CRTSCTS)
465 		uport->status |= UPSTAT_CTS_ENABLE;
466 	else
467 		uport->status &= ~UPSTAT_CTS_ENABLE;
468 
469 	if (termios->c_cflag & CLOCAL)
470 		uport->status &= ~UPSTAT_DCD_ENABLE;
471 	else
472 		uport->status |= UPSTAT_DCD_ENABLE;
473 
474 	/* reset sw-assisted CTS flow control based on (possibly) new mode */
475 	hw_stopped = uport->hw_stopped;
476 	uport->hw_stopped = uart_softcts_mode(uport) &&
477 				!(uport->ops->get_mctrl(uport) & TIOCM_CTS);
478 	if (uport->hw_stopped) {
479 		if (!hw_stopped)
480 			uport->ops->stop_tx(uport);
481 	} else {
482 		if (hw_stopped)
483 			__uart_start(tty);
484 	}
485 	spin_unlock_irq(&uport->lock);
486 }
487 
488 static inline int __uart_put_char(struct uart_port *port,
489 				struct circ_buf *circ, unsigned char c)
490 {
491 	unsigned long flags;
492 	int ret = 0;
493 
494 	if (!circ->buf)
495 		return 0;
496 
497 	spin_lock_irqsave(&port->lock, flags);
498 	if (uart_circ_chars_free(circ) != 0) {
499 		circ->buf[circ->head] = c;
500 		circ->head = (circ->head + 1) & (UART_XMIT_SIZE - 1);
501 		ret = 1;
502 	}
503 	spin_unlock_irqrestore(&port->lock, flags);
504 	return ret;
505 }
506 
507 static int uart_put_char(struct tty_struct *tty, unsigned char ch)
508 {
509 	struct uart_state *state = tty->driver_data;
510 
511 	return __uart_put_char(state->uart_port, &state->xmit, ch);
512 }
513 
514 static void uart_flush_chars(struct tty_struct *tty)
515 {
516 	uart_start(tty);
517 }
518 
519 static int uart_write(struct tty_struct *tty,
520 					const unsigned char *buf, int count)
521 {
522 	struct uart_state *state = tty->driver_data;
523 	struct uart_port *port;
524 	struct circ_buf *circ;
525 	unsigned long flags;
526 	int c, ret = 0;
527 
528 	/*
529 	 * This means you called this function _after_ the port was
530 	 * closed.  No cookie for you.
531 	 */
532 	if (!state) {
533 		WARN_ON(1);
534 		return -EL3HLT;
535 	}
536 
537 	port = state->uart_port;
538 	circ = &state->xmit;
539 
540 	if (!circ->buf)
541 		return 0;
542 
543 	spin_lock_irqsave(&port->lock, flags);
544 	while (1) {
545 		c = CIRC_SPACE_TO_END(circ->head, circ->tail, UART_XMIT_SIZE);
546 		if (count < c)
547 			c = count;
548 		if (c <= 0)
549 			break;
550 		memcpy(circ->buf + circ->head, buf, c);
551 		circ->head = (circ->head + c) & (UART_XMIT_SIZE - 1);
552 		buf += c;
553 		count -= c;
554 		ret += c;
555 	}
556 
557 	__uart_start(tty);
558 	spin_unlock_irqrestore(&port->lock, flags);
559 
560 	return ret;
561 }
562 
563 static int uart_write_room(struct tty_struct *tty)
564 {
565 	struct uart_state *state = tty->driver_data;
566 	unsigned long flags;
567 	int ret;
568 
569 	spin_lock_irqsave(&state->uart_port->lock, flags);
570 	ret = uart_circ_chars_free(&state->xmit);
571 	spin_unlock_irqrestore(&state->uart_port->lock, flags);
572 	return ret;
573 }
574 
575 static int uart_chars_in_buffer(struct tty_struct *tty)
576 {
577 	struct uart_state *state = tty->driver_data;
578 	unsigned long flags;
579 	int ret;
580 
581 	spin_lock_irqsave(&state->uart_port->lock, flags);
582 	ret = uart_circ_chars_pending(&state->xmit);
583 	spin_unlock_irqrestore(&state->uart_port->lock, flags);
584 	return ret;
585 }
586 
587 static void uart_flush_buffer(struct tty_struct *tty)
588 {
589 	struct uart_state *state = tty->driver_data;
590 	struct uart_port *port;
591 	unsigned long flags;
592 
593 	/*
594 	 * This means you called this function _after_ the port was
595 	 * closed.  No cookie for you.
596 	 */
597 	if (!state) {
598 		WARN_ON(1);
599 		return;
600 	}
601 
602 	port = state->uart_port;
603 	pr_debug("uart_flush_buffer(%d) called\n", tty->index);
604 
605 	spin_lock_irqsave(&port->lock, flags);
606 	uart_circ_clear(&state->xmit);
607 	if (port->ops->flush_buffer)
608 		port->ops->flush_buffer(port);
609 	spin_unlock_irqrestore(&port->lock, flags);
610 	tty_wakeup(tty);
611 }
612 
613 /*
614  * This function is used to send a high-priority XON/XOFF character to
615  * the device
616  */
617 static void uart_send_xchar(struct tty_struct *tty, char ch)
618 {
619 	struct uart_state *state = tty->driver_data;
620 	struct uart_port *port = state->uart_port;
621 	unsigned long flags;
622 
623 	if (port->ops->send_xchar)
624 		port->ops->send_xchar(port, ch);
625 	else {
626 		spin_lock_irqsave(&port->lock, flags);
627 		port->x_char = ch;
628 		if (ch)
629 			port->ops->start_tx(port);
630 		spin_unlock_irqrestore(&port->lock, flags);
631 	}
632 }
633 
634 static void uart_throttle(struct tty_struct *tty)
635 {
636 	struct uart_state *state = tty->driver_data;
637 	struct uart_port *port = state->uart_port;
638 	upstat_t mask = 0;
639 
640 	if (I_IXOFF(tty))
641 		mask |= UPSTAT_AUTOXOFF;
642 	if (tty->termios.c_cflag & CRTSCTS)
643 		mask |= UPSTAT_AUTORTS;
644 
645 	if (port->status & mask) {
646 		port->ops->throttle(port);
647 		mask &= ~port->status;
648 	}
649 
650 	if (mask & UPSTAT_AUTOXOFF)
651 		uart_send_xchar(tty, STOP_CHAR(tty));
652 
653 	if (mask & UPSTAT_AUTORTS)
654 		uart_clear_mctrl(port, TIOCM_RTS);
655 }
656 
657 static void uart_unthrottle(struct tty_struct *tty)
658 {
659 	struct uart_state *state = tty->driver_data;
660 	struct uart_port *port = state->uart_port;
661 	upstat_t mask = 0;
662 
663 	if (I_IXOFF(tty))
664 		mask |= UPSTAT_AUTOXOFF;
665 	if (tty->termios.c_cflag & CRTSCTS)
666 		mask |= UPSTAT_AUTORTS;
667 
668 	if (port->status & mask) {
669 		port->ops->unthrottle(port);
670 		mask &= ~port->status;
671 	}
672 
673 	if (mask & UPSTAT_AUTOXOFF)
674 		uart_send_xchar(tty, START_CHAR(tty));
675 
676 	if (mask & UPSTAT_AUTORTS)
677 		uart_set_mctrl(port, TIOCM_RTS);
678 }
679 
680 static void do_uart_get_info(struct tty_port *port,
681 			struct serial_struct *retinfo)
682 {
683 	struct uart_state *state = container_of(port, struct uart_state, port);
684 	struct uart_port *uport = state->uart_port;
685 
686 	memset(retinfo, 0, sizeof(*retinfo));
687 
688 	retinfo->type	    = uport->type;
689 	retinfo->line	    = uport->line;
690 	retinfo->port	    = uport->iobase;
691 	if (HIGH_BITS_OFFSET)
692 		retinfo->port_high = (long) uport->iobase >> HIGH_BITS_OFFSET;
693 	retinfo->irq		    = uport->irq;
694 	retinfo->flags	    = uport->flags;
695 	retinfo->xmit_fifo_size  = uport->fifosize;
696 	retinfo->baud_base	    = uport->uartclk / 16;
697 	retinfo->close_delay	    = jiffies_to_msecs(port->close_delay) / 10;
698 	retinfo->closing_wait    = port->closing_wait == ASYNC_CLOSING_WAIT_NONE ?
699 				ASYNC_CLOSING_WAIT_NONE :
700 				jiffies_to_msecs(port->closing_wait) / 10;
701 	retinfo->custom_divisor  = uport->custom_divisor;
702 	retinfo->hub6	    = uport->hub6;
703 	retinfo->io_type         = uport->iotype;
704 	retinfo->iomem_reg_shift = uport->regshift;
705 	retinfo->iomem_base      = (void *)(unsigned long)uport->mapbase;
706 }
707 
708 static void uart_get_info(struct tty_port *port,
709 			struct serial_struct *retinfo)
710 {
711 	/* Ensure the state we copy is consistent and no hardware changes
712 	   occur as we go */
713 	mutex_lock(&port->mutex);
714 	do_uart_get_info(port, retinfo);
715 	mutex_unlock(&port->mutex);
716 }
717 
718 static int uart_get_info_user(struct tty_port *port,
719 			 struct serial_struct __user *retinfo)
720 {
721 	struct serial_struct tmp;
722 	uart_get_info(port, &tmp);
723 
724 	if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
725 		return -EFAULT;
726 	return 0;
727 }
728 
729 static int uart_set_info(struct tty_struct *tty, struct tty_port *port,
730 			 struct uart_state *state,
731 			 struct serial_struct *new_info)
732 {
733 	struct uart_port *uport = state->uart_port;
734 	unsigned long new_port;
735 	unsigned int change_irq, change_port, closing_wait;
736 	unsigned int old_custom_divisor, close_delay;
737 	upf_t old_flags, new_flags;
738 	int retval = 0;
739 
740 	new_port = new_info->port;
741 	if (HIGH_BITS_OFFSET)
742 		new_port += (unsigned long) new_info->port_high << HIGH_BITS_OFFSET;
743 
744 	new_info->irq = irq_canonicalize(new_info->irq);
745 	close_delay = msecs_to_jiffies(new_info->close_delay * 10);
746 	closing_wait = new_info->closing_wait == ASYNC_CLOSING_WAIT_NONE ?
747 			ASYNC_CLOSING_WAIT_NONE :
748 			msecs_to_jiffies(new_info->closing_wait * 10);
749 
750 
751 	change_irq  = !(uport->flags & UPF_FIXED_PORT)
752 		&& new_info->irq != uport->irq;
753 
754 	/*
755 	 * Since changing the 'type' of the port changes its resource
756 	 * allocations, we should treat type changes the same as
757 	 * IO port changes.
758 	 */
759 	change_port = !(uport->flags & UPF_FIXED_PORT)
760 		&& (new_port != uport->iobase ||
761 		    (unsigned long)new_info->iomem_base != uport->mapbase ||
762 		    new_info->hub6 != uport->hub6 ||
763 		    new_info->io_type != uport->iotype ||
764 		    new_info->iomem_reg_shift != uport->regshift ||
765 		    new_info->type != uport->type);
766 
767 	old_flags = uport->flags;
768 	new_flags = new_info->flags;
769 	old_custom_divisor = uport->custom_divisor;
770 
771 	if (!capable(CAP_SYS_ADMIN)) {
772 		retval = -EPERM;
773 		if (change_irq || change_port ||
774 		    (new_info->baud_base != uport->uartclk / 16) ||
775 		    (close_delay != port->close_delay) ||
776 		    (closing_wait != port->closing_wait) ||
777 		    (new_info->xmit_fifo_size &&
778 		     new_info->xmit_fifo_size != uport->fifosize) ||
779 		    (((new_flags ^ old_flags) & ~UPF_USR_MASK) != 0))
780 			goto exit;
781 		uport->flags = ((uport->flags & ~UPF_USR_MASK) |
782 			       (new_flags & UPF_USR_MASK));
783 		uport->custom_divisor = new_info->custom_divisor;
784 		goto check_and_exit;
785 	}
786 
787 	/*
788 	 * Ask the low level driver to verify the settings.
789 	 */
790 	if (uport->ops->verify_port)
791 		retval = uport->ops->verify_port(uport, new_info);
792 
793 	if ((new_info->irq >= nr_irqs) || (new_info->irq < 0) ||
794 	    (new_info->baud_base < 9600))
795 		retval = -EINVAL;
796 
797 	if (retval)
798 		goto exit;
799 
800 	if (change_port || change_irq) {
801 		retval = -EBUSY;
802 
803 		/*
804 		 * Make sure that we are the sole user of this port.
805 		 */
806 		if (tty_port_users(port) > 1)
807 			goto exit;
808 
809 		/*
810 		 * We need to shutdown the serial port at the old
811 		 * port/type/irq combination.
812 		 */
813 		uart_shutdown(tty, state);
814 	}
815 
816 	if (change_port) {
817 		unsigned long old_iobase, old_mapbase;
818 		unsigned int old_type, old_iotype, old_hub6, old_shift;
819 
820 		old_iobase = uport->iobase;
821 		old_mapbase = uport->mapbase;
822 		old_type = uport->type;
823 		old_hub6 = uport->hub6;
824 		old_iotype = uport->iotype;
825 		old_shift = uport->regshift;
826 
827 		/*
828 		 * Free and release old regions
829 		 */
830 		if (old_type != PORT_UNKNOWN)
831 			uport->ops->release_port(uport);
832 
833 		uport->iobase = new_port;
834 		uport->type = new_info->type;
835 		uport->hub6 = new_info->hub6;
836 		uport->iotype = new_info->io_type;
837 		uport->regshift = new_info->iomem_reg_shift;
838 		uport->mapbase = (unsigned long)new_info->iomem_base;
839 
840 		/*
841 		 * Claim and map the new regions
842 		 */
843 		if (uport->type != PORT_UNKNOWN) {
844 			retval = uport->ops->request_port(uport);
845 		} else {
846 			/* Always success - Jean II */
847 			retval = 0;
848 		}
849 
850 		/*
851 		 * If we fail to request resources for the
852 		 * new port, try to restore the old settings.
853 		 */
854 		if (retval) {
855 			uport->iobase = old_iobase;
856 			uport->type = old_type;
857 			uport->hub6 = old_hub6;
858 			uport->iotype = old_iotype;
859 			uport->regshift = old_shift;
860 			uport->mapbase = old_mapbase;
861 
862 			if (old_type != PORT_UNKNOWN) {
863 				retval = uport->ops->request_port(uport);
864 				/*
865 				 * If we failed to restore the old settings,
866 				 * we fail like this.
867 				 */
868 				if (retval)
869 					uport->type = PORT_UNKNOWN;
870 
871 				/*
872 				 * We failed anyway.
873 				 */
874 				retval = -EBUSY;
875 			}
876 
877 			/* Added to return the correct error -Ram Gupta */
878 			goto exit;
879 		}
880 	}
881 
882 	if (change_irq)
883 		uport->irq      = new_info->irq;
884 	if (!(uport->flags & UPF_FIXED_PORT))
885 		uport->uartclk  = new_info->baud_base * 16;
886 	uport->flags            = (uport->flags & ~UPF_CHANGE_MASK) |
887 				 (new_flags & UPF_CHANGE_MASK);
888 	uport->custom_divisor   = new_info->custom_divisor;
889 	port->close_delay     = close_delay;
890 	port->closing_wait    = closing_wait;
891 	if (new_info->xmit_fifo_size)
892 		uport->fifosize = new_info->xmit_fifo_size;
893 	port->low_latency = (uport->flags & UPF_LOW_LATENCY) ? 1 : 0;
894 
895  check_and_exit:
896 	retval = 0;
897 	if (uport->type == PORT_UNKNOWN)
898 		goto exit;
899 	if (port->flags & ASYNC_INITIALIZED) {
900 		if (((old_flags ^ uport->flags) & UPF_SPD_MASK) ||
901 		    old_custom_divisor != uport->custom_divisor) {
902 			/*
903 			 * If they're setting up a custom divisor or speed,
904 			 * instead of clearing it, then bitch about it. No
905 			 * need to rate-limit; it's CAP_SYS_ADMIN only.
906 			 */
907 			if (uport->flags & UPF_SPD_MASK) {
908 				dev_notice(uport->dev,
909 				       "%s sets custom speed on %s. This is deprecated.\n",
910 				      current->comm,
911 				      tty_name(port->tty));
912 			}
913 			uart_change_speed(tty, state, NULL);
914 		}
915 	} else
916 		retval = uart_startup(tty, state, 1);
917  exit:
918 	return retval;
919 }
920 
921 static int uart_set_info_user(struct tty_struct *tty, struct uart_state *state,
922 			 struct serial_struct __user *newinfo)
923 {
924 	struct serial_struct new_serial;
925 	struct tty_port *port = &state->port;
926 	int retval;
927 
928 	if (copy_from_user(&new_serial, newinfo, sizeof(new_serial)))
929 		return -EFAULT;
930 
931 	/*
932 	 * This semaphore protects port->count.  It is also
933 	 * very useful to prevent opens.  Also, take the
934 	 * port configuration semaphore to make sure that a
935 	 * module insertion/removal doesn't change anything
936 	 * under us.
937 	 */
938 	mutex_lock(&port->mutex);
939 	retval = uart_set_info(tty, port, state, &new_serial);
940 	mutex_unlock(&port->mutex);
941 	return retval;
942 }
943 
944 /**
945  *	uart_get_lsr_info	-	get line status register info
946  *	@tty: tty associated with the UART
947  *	@state: UART being queried
948  *	@value: returned modem value
949  *
950  *	Note: uart_ioctl protects us against hangups.
951  */
952 static int uart_get_lsr_info(struct tty_struct *tty,
953 			struct uart_state *state, unsigned int __user *value)
954 {
955 	struct uart_port *uport = state->uart_port;
956 	unsigned int result;
957 
958 	result = uport->ops->tx_empty(uport);
959 
960 	/*
961 	 * If we're about to load something into the transmit
962 	 * register, we'll pretend the transmitter isn't empty to
963 	 * avoid a race condition (depending on when the transmit
964 	 * interrupt happens).
965 	 */
966 	if (uport->x_char ||
967 	    ((uart_circ_chars_pending(&state->xmit) > 0) &&
968 	     !uart_tx_stopped(uport)))
969 		result &= ~TIOCSER_TEMT;
970 
971 	return put_user(result, value);
972 }
973 
974 static int uart_tiocmget(struct tty_struct *tty)
975 {
976 	struct uart_state *state = tty->driver_data;
977 	struct tty_port *port = &state->port;
978 	struct uart_port *uport = state->uart_port;
979 	int result = -EIO;
980 
981 	mutex_lock(&port->mutex);
982 	if (!(tty->flags & (1 << TTY_IO_ERROR))) {
983 		result = uport->mctrl;
984 		spin_lock_irq(&uport->lock);
985 		result |= uport->ops->get_mctrl(uport);
986 		spin_unlock_irq(&uport->lock);
987 	}
988 	mutex_unlock(&port->mutex);
989 
990 	return result;
991 }
992 
993 static int
994 uart_tiocmset(struct tty_struct *tty, unsigned int set, unsigned int clear)
995 {
996 	struct uart_state *state = tty->driver_data;
997 	struct uart_port *uport = state->uart_port;
998 	struct tty_port *port = &state->port;
999 	int ret = -EIO;
1000 
1001 	mutex_lock(&port->mutex);
1002 	if (!(tty->flags & (1 << TTY_IO_ERROR))) {
1003 		uart_update_mctrl(uport, set, clear);
1004 		ret = 0;
1005 	}
1006 	mutex_unlock(&port->mutex);
1007 	return ret;
1008 }
1009 
1010 static int uart_break_ctl(struct tty_struct *tty, int break_state)
1011 {
1012 	struct uart_state *state = tty->driver_data;
1013 	struct tty_port *port = &state->port;
1014 	struct uart_port *uport = state->uart_port;
1015 
1016 	mutex_lock(&port->mutex);
1017 
1018 	if (uport->type != PORT_UNKNOWN)
1019 		uport->ops->break_ctl(uport, break_state);
1020 
1021 	mutex_unlock(&port->mutex);
1022 	return 0;
1023 }
1024 
1025 static int uart_do_autoconfig(struct tty_struct *tty,struct uart_state *state)
1026 {
1027 	struct uart_port *uport = state->uart_port;
1028 	struct tty_port *port = &state->port;
1029 	int flags, ret;
1030 
1031 	if (!capable(CAP_SYS_ADMIN))
1032 		return -EPERM;
1033 
1034 	/*
1035 	 * Take the per-port semaphore.  This prevents count from
1036 	 * changing, and hence any extra opens of the port while
1037 	 * we're auto-configuring.
1038 	 */
1039 	if (mutex_lock_interruptible(&port->mutex))
1040 		return -ERESTARTSYS;
1041 
1042 	ret = -EBUSY;
1043 	if (tty_port_users(port) == 1) {
1044 		uart_shutdown(tty, state);
1045 
1046 		/*
1047 		 * If we already have a port type configured,
1048 		 * we must release its resources.
1049 		 */
1050 		if (uport->type != PORT_UNKNOWN)
1051 			uport->ops->release_port(uport);
1052 
1053 		flags = UART_CONFIG_TYPE;
1054 		if (uport->flags & UPF_AUTO_IRQ)
1055 			flags |= UART_CONFIG_IRQ;
1056 
1057 		/*
1058 		 * This will claim the ports resources if
1059 		 * a port is found.
1060 		 */
1061 		uport->ops->config_port(uport, flags);
1062 
1063 		ret = uart_startup(tty, state, 1);
1064 	}
1065 	mutex_unlock(&port->mutex);
1066 	return ret;
1067 }
1068 
1069 static void uart_enable_ms(struct uart_port *uport)
1070 {
1071 	/*
1072 	 * Force modem status interrupts on
1073 	 */
1074 	if (uport->ops->enable_ms)
1075 		uport->ops->enable_ms(uport);
1076 }
1077 
1078 /*
1079  * Wait for any of the 4 modem inputs (DCD,RI,DSR,CTS) to change
1080  * - mask passed in arg for lines of interest
1081  *   (use |'ed TIOCM_RNG/DSR/CD/CTS for masking)
1082  * Caller should use TIOCGICOUNT to see which one it was
1083  *
1084  * FIXME: This wants extracting into a common all driver implementation
1085  * of TIOCMWAIT using tty_port.
1086  */
1087 static int
1088 uart_wait_modem_status(struct uart_state *state, unsigned long arg)
1089 {
1090 	struct uart_port *uport = state->uart_port;
1091 	struct tty_port *port = &state->port;
1092 	DECLARE_WAITQUEUE(wait, current);
1093 	struct uart_icount cprev, cnow;
1094 	int ret;
1095 
1096 	/*
1097 	 * note the counters on entry
1098 	 */
1099 	spin_lock_irq(&uport->lock);
1100 	memcpy(&cprev, &uport->icount, sizeof(struct uart_icount));
1101 	uart_enable_ms(uport);
1102 	spin_unlock_irq(&uport->lock);
1103 
1104 	add_wait_queue(&port->delta_msr_wait, &wait);
1105 	for (;;) {
1106 		spin_lock_irq(&uport->lock);
1107 		memcpy(&cnow, &uport->icount, sizeof(struct uart_icount));
1108 		spin_unlock_irq(&uport->lock);
1109 
1110 		set_current_state(TASK_INTERRUPTIBLE);
1111 
1112 		if (((arg & TIOCM_RNG) && (cnow.rng != cprev.rng)) ||
1113 		    ((arg & TIOCM_DSR) && (cnow.dsr != cprev.dsr)) ||
1114 		    ((arg & TIOCM_CD)  && (cnow.dcd != cprev.dcd)) ||
1115 		    ((arg & TIOCM_CTS) && (cnow.cts != cprev.cts))) {
1116 			ret = 0;
1117 			break;
1118 		}
1119 
1120 		schedule();
1121 
1122 		/* see if a signal did it */
1123 		if (signal_pending(current)) {
1124 			ret = -ERESTARTSYS;
1125 			break;
1126 		}
1127 
1128 		cprev = cnow;
1129 	}
1130 	__set_current_state(TASK_RUNNING);
1131 	remove_wait_queue(&port->delta_msr_wait, &wait);
1132 
1133 	return ret;
1134 }
1135 
1136 /*
1137  * Get counter of input serial line interrupts (DCD,RI,DSR,CTS)
1138  * Return: write counters to the user passed counter struct
1139  * NB: both 1->0 and 0->1 transitions are counted except for
1140  *     RI where only 0->1 is counted.
1141  */
1142 static int uart_get_icount(struct tty_struct *tty,
1143 			  struct serial_icounter_struct *icount)
1144 {
1145 	struct uart_state *state = tty->driver_data;
1146 	struct uart_icount cnow;
1147 	struct uart_port *uport = state->uart_port;
1148 
1149 	spin_lock_irq(&uport->lock);
1150 	memcpy(&cnow, &uport->icount, sizeof(struct uart_icount));
1151 	spin_unlock_irq(&uport->lock);
1152 
1153 	icount->cts         = cnow.cts;
1154 	icount->dsr         = cnow.dsr;
1155 	icount->rng         = cnow.rng;
1156 	icount->dcd         = cnow.dcd;
1157 	icount->rx          = cnow.rx;
1158 	icount->tx          = cnow.tx;
1159 	icount->frame       = cnow.frame;
1160 	icount->overrun     = cnow.overrun;
1161 	icount->parity      = cnow.parity;
1162 	icount->brk         = cnow.brk;
1163 	icount->buf_overrun = cnow.buf_overrun;
1164 
1165 	return 0;
1166 }
1167 
1168 static int uart_get_rs485_config(struct uart_port *port,
1169 			 struct serial_rs485 __user *rs485)
1170 {
1171 	unsigned long flags;
1172 	struct serial_rs485 aux;
1173 
1174 	spin_lock_irqsave(&port->lock, flags);
1175 	aux = port->rs485;
1176 	spin_unlock_irqrestore(&port->lock, flags);
1177 
1178 	if (copy_to_user(rs485, &aux, sizeof(aux)))
1179 		return -EFAULT;
1180 
1181 	return 0;
1182 }
1183 
1184 static int uart_set_rs485_config(struct uart_port *port,
1185 			 struct serial_rs485 __user *rs485_user)
1186 {
1187 	struct serial_rs485 rs485;
1188 	int ret;
1189 	unsigned long flags;
1190 
1191 	if (!port->rs485_config)
1192 		return -ENOIOCTLCMD;
1193 
1194 	if (copy_from_user(&rs485, rs485_user, sizeof(*rs485_user)))
1195 		return -EFAULT;
1196 
1197 	spin_lock_irqsave(&port->lock, flags);
1198 	ret = port->rs485_config(port, &rs485);
1199 	spin_unlock_irqrestore(&port->lock, flags);
1200 	if (ret)
1201 		return ret;
1202 
1203 	if (copy_to_user(rs485_user, &port->rs485, sizeof(port->rs485)))
1204 		return -EFAULT;
1205 
1206 	return 0;
1207 }
1208 
1209 /*
1210  * Called via sys_ioctl.  We can use spin_lock_irq() here.
1211  */
1212 static int
1213 uart_ioctl(struct tty_struct *tty, unsigned int cmd,
1214 	   unsigned long arg)
1215 {
1216 	struct uart_state *state = tty->driver_data;
1217 	struct tty_port *port = &state->port;
1218 	void __user *uarg = (void __user *)arg;
1219 	int ret = -ENOIOCTLCMD;
1220 
1221 
1222 	/*
1223 	 * These ioctls don't rely on the hardware to be present.
1224 	 */
1225 	switch (cmd) {
1226 	case TIOCGSERIAL:
1227 		ret = uart_get_info_user(port, uarg);
1228 		break;
1229 
1230 	case TIOCSSERIAL:
1231 		down_write(&tty->termios_rwsem);
1232 		ret = uart_set_info_user(tty, state, uarg);
1233 		up_write(&tty->termios_rwsem);
1234 		break;
1235 
1236 	case TIOCSERCONFIG:
1237 		down_write(&tty->termios_rwsem);
1238 		ret = uart_do_autoconfig(tty, state);
1239 		up_write(&tty->termios_rwsem);
1240 		break;
1241 
1242 	case TIOCSERGWILD: /* obsolete */
1243 	case TIOCSERSWILD: /* obsolete */
1244 		ret = 0;
1245 		break;
1246 	}
1247 
1248 	if (ret != -ENOIOCTLCMD)
1249 		goto out;
1250 
1251 	if (tty->flags & (1 << TTY_IO_ERROR)) {
1252 		ret = -EIO;
1253 		goto out;
1254 	}
1255 
1256 	/*
1257 	 * The following should only be used when hardware is present.
1258 	 */
1259 	switch (cmd) {
1260 	case TIOCMIWAIT:
1261 		ret = uart_wait_modem_status(state, arg);
1262 		break;
1263 	}
1264 
1265 	if (ret != -ENOIOCTLCMD)
1266 		goto out;
1267 
1268 	mutex_lock(&port->mutex);
1269 
1270 	if (tty->flags & (1 << TTY_IO_ERROR)) {
1271 		ret = -EIO;
1272 		goto out_up;
1273 	}
1274 
1275 	/*
1276 	 * All these rely on hardware being present and need to be
1277 	 * protected against the tty being hung up.
1278 	 */
1279 
1280 	switch (cmd) {
1281 	case TIOCSERGETLSR: /* Get line status register */
1282 		ret = uart_get_lsr_info(tty, state, uarg);
1283 		break;
1284 
1285 	case TIOCGRS485:
1286 		ret = uart_get_rs485_config(state->uart_port, uarg);
1287 		break;
1288 
1289 	case TIOCSRS485:
1290 		ret = uart_set_rs485_config(state->uart_port, uarg);
1291 		break;
1292 	default: {
1293 		struct uart_port *uport = state->uart_port;
1294 		if (uport->ops->ioctl)
1295 			ret = uport->ops->ioctl(uport, cmd, arg);
1296 		break;
1297 	}
1298 	}
1299 out_up:
1300 	mutex_unlock(&port->mutex);
1301 out:
1302 	return ret;
1303 }
1304 
1305 static void uart_set_ldisc(struct tty_struct *tty)
1306 {
1307 	struct uart_state *state = tty->driver_data;
1308 	struct uart_port *uport = state->uart_port;
1309 
1310 	if (uport->ops->set_ldisc) {
1311 		mutex_lock(&state->port.mutex);
1312 		uport->ops->set_ldisc(uport, &tty->termios);
1313 		mutex_unlock(&state->port.mutex);
1314 	}
1315 }
1316 
1317 static void uart_set_termios(struct tty_struct *tty,
1318 						struct ktermios *old_termios)
1319 {
1320 	struct uart_state *state = tty->driver_data;
1321 	struct uart_port *uport = state->uart_port;
1322 	unsigned int cflag = tty->termios.c_cflag;
1323 	unsigned int iflag_mask = IGNBRK|BRKINT|IGNPAR|PARMRK|INPCK;
1324 	bool sw_changed = false;
1325 
1326 	/*
1327 	 * Drivers doing software flow control also need to know
1328 	 * about changes to these input settings.
1329 	 */
1330 	if (uport->flags & UPF_SOFT_FLOW) {
1331 		iflag_mask |= IXANY|IXON|IXOFF;
1332 		sw_changed =
1333 		   tty->termios.c_cc[VSTART] != old_termios->c_cc[VSTART] ||
1334 		   tty->termios.c_cc[VSTOP] != old_termios->c_cc[VSTOP];
1335 	}
1336 
1337 	/*
1338 	 * These are the bits that are used to setup various
1339 	 * flags in the low level driver. We can ignore the Bfoo
1340 	 * bits in c_cflag; c_[io]speed will always be set
1341 	 * appropriately by set_termios() in tty_ioctl.c
1342 	 */
1343 	if ((cflag ^ old_termios->c_cflag) == 0 &&
1344 	    tty->termios.c_ospeed == old_termios->c_ospeed &&
1345 	    tty->termios.c_ispeed == old_termios->c_ispeed &&
1346 	    ((tty->termios.c_iflag ^ old_termios->c_iflag) & iflag_mask) == 0 &&
1347 	    !sw_changed) {
1348 		return;
1349 	}
1350 
1351 	mutex_lock(&state->port.mutex);
1352 	uart_change_speed(tty, state, old_termios);
1353 	mutex_unlock(&state->port.mutex);
1354 	/* reload cflag from termios; port driver may have overriden flags */
1355 	cflag = tty->termios.c_cflag;
1356 
1357 	/* Handle transition to B0 status */
1358 	if ((old_termios->c_cflag & CBAUD) && !(cflag & CBAUD))
1359 		uart_clear_mctrl(uport, TIOCM_RTS | TIOCM_DTR);
1360 	/* Handle transition away from B0 status */
1361 	else if (!(old_termios->c_cflag & CBAUD) && (cflag & CBAUD)) {
1362 		unsigned int mask = TIOCM_DTR;
1363 		if (!(cflag & CRTSCTS) || !test_bit(TTY_THROTTLED, &tty->flags))
1364 			mask |= TIOCM_RTS;
1365 		uart_set_mctrl(uport, mask);
1366 	}
1367 }
1368 
1369 /*
1370  * Calls to uart_close() are serialised via the tty_lock in
1371  *   drivers/tty/tty_io.c:tty_release()
1372  *   drivers/tty/tty_io.c:do_tty_hangup()
1373  * This runs from a workqueue and can sleep for a _short_ time only.
1374  */
1375 static void uart_close(struct tty_struct *tty, struct file *filp)
1376 {
1377 	struct uart_state *state = tty->driver_data;
1378 	struct tty_port *port;
1379 	struct uart_port *uport;
1380 
1381 	if (!state) {
1382 		struct uart_driver *drv = tty->driver->driver_state;
1383 
1384 		state = drv->state + tty->index;
1385 		port = &state->port;
1386 		spin_lock_irq(&port->lock);
1387 		--port->count;
1388 		spin_unlock_irq(&port->lock);
1389 		return;
1390 	}
1391 
1392 	uport = state->uart_port;
1393 	port = &state->port;
1394 
1395 	pr_debug("uart_close(%d) called\n", uport ? uport->line : -1);
1396 
1397 	if (!port->count || tty_port_close_start(port, tty, filp) == 0)
1398 		return;
1399 
1400 	/*
1401 	 * At this point, we stop accepting input.  To do this, we
1402 	 * disable the receive line status interrupts.
1403 	 */
1404 	if (port->flags & ASYNC_INITIALIZED) {
1405 		spin_lock_irq(&uport->lock);
1406 		uport->ops->stop_rx(uport);
1407 		spin_unlock_irq(&uport->lock);
1408 		/*
1409 		 * Before we drop DTR, make sure the UART transmitter
1410 		 * has completely drained; this is especially
1411 		 * important if there is a transmit FIFO!
1412 		 */
1413 		uart_wait_until_sent(tty, uport->timeout);
1414 	}
1415 
1416 	mutex_lock(&port->mutex);
1417 	uart_shutdown(tty, state);
1418 	tty_port_tty_set(port, NULL);
1419 
1420 	spin_lock_irq(&port->lock);
1421 
1422 	if (port->blocked_open) {
1423 		spin_unlock_irq(&port->lock);
1424 		if (port->close_delay)
1425 			msleep_interruptible(jiffies_to_msecs(port->close_delay));
1426 		spin_lock_irq(&port->lock);
1427 	} else if (!uart_console(uport)) {
1428 		spin_unlock_irq(&port->lock);
1429 		uart_change_pm(state, UART_PM_STATE_OFF);
1430 		spin_lock_irq(&port->lock);
1431 	}
1432 
1433 	/*
1434 	 * Wake up anyone trying to open this port.
1435 	 */
1436 	clear_bit(ASYNCB_NORMAL_ACTIVE, &port->flags);
1437 	clear_bit(ASYNCB_CLOSING, &port->flags);
1438 	spin_unlock_irq(&port->lock);
1439 	wake_up_interruptible(&port->open_wait);
1440 
1441 	mutex_unlock(&port->mutex);
1442 
1443 	tty_ldisc_flush(tty);
1444 	tty->closing = 0;
1445 }
1446 
1447 static void uart_wait_until_sent(struct tty_struct *tty, int timeout)
1448 {
1449 	struct uart_state *state = tty->driver_data;
1450 	struct uart_port *port = state->uart_port;
1451 	unsigned long char_time, expire;
1452 
1453 	if (port->type == PORT_UNKNOWN || port->fifosize == 0)
1454 		return;
1455 
1456 	/*
1457 	 * Set the check interval to be 1/5 of the estimated time to
1458 	 * send a single character, and make it at least 1.  The check
1459 	 * interval should also be less than the timeout.
1460 	 *
1461 	 * Note: we have to use pretty tight timings here to satisfy
1462 	 * the NIST-PCTS.
1463 	 */
1464 	char_time = (port->timeout - HZ/50) / port->fifosize;
1465 	char_time = char_time / 5;
1466 	if (char_time == 0)
1467 		char_time = 1;
1468 	if (timeout && timeout < char_time)
1469 		char_time = timeout;
1470 
1471 	/*
1472 	 * If the transmitter hasn't cleared in twice the approximate
1473 	 * amount of time to send the entire FIFO, it probably won't
1474 	 * ever clear.  This assumes the UART isn't doing flow
1475 	 * control, which is currently the case.  Hence, if it ever
1476 	 * takes longer than port->timeout, this is probably due to a
1477 	 * UART bug of some kind.  So, we clamp the timeout parameter at
1478 	 * 2*port->timeout.
1479 	 */
1480 	if (timeout == 0 || timeout > 2 * port->timeout)
1481 		timeout = 2 * port->timeout;
1482 
1483 	expire = jiffies + timeout;
1484 
1485 	pr_debug("uart_wait_until_sent(%d), jiffies=%lu, expire=%lu...\n",
1486 		port->line, jiffies, expire);
1487 
1488 	/*
1489 	 * Check whether the transmitter is empty every 'char_time'.
1490 	 * 'timeout' / 'expire' give us the maximum amount of time
1491 	 * we wait.
1492 	 */
1493 	while (!port->ops->tx_empty(port)) {
1494 		msleep_interruptible(jiffies_to_msecs(char_time));
1495 		if (signal_pending(current))
1496 			break;
1497 		if (time_after(jiffies, expire))
1498 			break;
1499 	}
1500 }
1501 
1502 /*
1503  * Calls to uart_hangup() are serialised by the tty_lock in
1504  *   drivers/tty/tty_io.c:do_tty_hangup()
1505  * This runs from a workqueue and can sleep for a _short_ time only.
1506  */
1507 static void uart_hangup(struct tty_struct *tty)
1508 {
1509 	struct uart_state *state = tty->driver_data;
1510 	struct tty_port *port = &state->port;
1511 	unsigned long flags;
1512 
1513 	pr_debug("uart_hangup(%d)\n", state->uart_port->line);
1514 
1515 	mutex_lock(&port->mutex);
1516 	if (port->flags & ASYNC_NORMAL_ACTIVE) {
1517 		uart_flush_buffer(tty);
1518 		uart_shutdown(tty, state);
1519 		spin_lock_irqsave(&port->lock, flags);
1520 		port->count = 0;
1521 		clear_bit(ASYNCB_NORMAL_ACTIVE, &port->flags);
1522 		spin_unlock_irqrestore(&port->lock, flags);
1523 		tty_port_tty_set(port, NULL);
1524 		if (!uart_console(state->uart_port))
1525 			uart_change_pm(state, UART_PM_STATE_OFF);
1526 		wake_up_interruptible(&port->open_wait);
1527 		wake_up_interruptible(&port->delta_msr_wait);
1528 	}
1529 	mutex_unlock(&port->mutex);
1530 }
1531 
1532 static void uart_port_shutdown(struct tty_port *port)
1533 {
1534 	struct uart_state *state = container_of(port, struct uart_state, port);
1535 	struct uart_port *uport = state->uart_port;
1536 
1537 	/*
1538 	 * clear delta_msr_wait queue to avoid mem leaks: we may free
1539 	 * the irq here so the queue might never be woken up.  Note
1540 	 * that we won't end up waiting on delta_msr_wait again since
1541 	 * any outstanding file descriptors should be pointing at
1542 	 * hung_up_tty_fops now.
1543 	 */
1544 	wake_up_interruptible(&port->delta_msr_wait);
1545 
1546 	/*
1547 	 * Free the IRQ and disable the port.
1548 	 */
1549 	uport->ops->shutdown(uport);
1550 
1551 	/*
1552 	 * Ensure that the IRQ handler isn't running on another CPU.
1553 	 */
1554 	synchronize_irq(uport->irq);
1555 }
1556 
1557 static int uart_carrier_raised(struct tty_port *port)
1558 {
1559 	struct uart_state *state = container_of(port, struct uart_state, port);
1560 	struct uart_port *uport = state->uart_port;
1561 	int mctrl;
1562 	spin_lock_irq(&uport->lock);
1563 	uart_enable_ms(uport);
1564 	mctrl = uport->ops->get_mctrl(uport);
1565 	spin_unlock_irq(&uport->lock);
1566 	if (mctrl & TIOCM_CAR)
1567 		return 1;
1568 	return 0;
1569 }
1570 
1571 static void uart_dtr_rts(struct tty_port *port, int onoff)
1572 {
1573 	struct uart_state *state = container_of(port, struct uart_state, port);
1574 	struct uart_port *uport = state->uart_port;
1575 
1576 	if (onoff)
1577 		uart_set_mctrl(uport, TIOCM_DTR | TIOCM_RTS);
1578 	else
1579 		uart_clear_mctrl(uport, TIOCM_DTR | TIOCM_RTS);
1580 }
1581 
1582 /*
1583  * Calls to uart_open are serialised by the tty_lock in
1584  *   drivers/tty/tty_io.c:tty_open()
1585  * Note that if this fails, then uart_close() _will_ be called.
1586  *
1587  * In time, we want to scrap the "opening nonpresent ports"
1588  * behaviour and implement an alternative way for setserial
1589  * to set base addresses/ports/types.  This will allow us to
1590  * get rid of a certain amount of extra tests.
1591  */
1592 static int uart_open(struct tty_struct *tty, struct file *filp)
1593 {
1594 	struct uart_driver *drv = (struct uart_driver *)tty->driver->driver_state;
1595 	int retval, line = tty->index;
1596 	struct uart_state *state = drv->state + line;
1597 	struct tty_port *port = &state->port;
1598 
1599 	pr_debug("uart_open(%d) called\n", line);
1600 
1601 	spin_lock_irq(&port->lock);
1602 	++port->count;
1603 	spin_unlock_irq(&port->lock);
1604 
1605 	/*
1606 	 * We take the semaphore here to guarantee that we won't be re-entered
1607 	 * while allocating the state structure, or while we request any IRQs
1608 	 * that the driver may need.  This also has the nice side-effect that
1609 	 * it delays the action of uart_hangup, so we can guarantee that
1610 	 * state->port.tty will always contain something reasonable.
1611 	 */
1612 	if (mutex_lock_interruptible(&port->mutex)) {
1613 		retval = -ERESTARTSYS;
1614 		goto end;
1615 	}
1616 
1617 	if (!state->uart_port || state->uart_port->flags & UPF_DEAD) {
1618 		retval = -ENXIO;
1619 		goto err_unlock;
1620 	}
1621 
1622 	tty->driver_data = state;
1623 	state->uart_port->state = state;
1624 	state->port.low_latency =
1625 		(state->uart_port->flags & UPF_LOW_LATENCY) ? 1 : 0;
1626 	tty_port_tty_set(port, tty);
1627 
1628 	/*
1629 	 * Start up the serial port.
1630 	 */
1631 	retval = uart_startup(tty, state, 0);
1632 
1633 	/*
1634 	 * If we succeeded, wait until the port is ready.
1635 	 */
1636 	mutex_unlock(&port->mutex);
1637 	if (retval == 0)
1638 		retval = tty_port_block_til_ready(port, tty, filp);
1639 
1640 end:
1641 	return retval;
1642 err_unlock:
1643 	mutex_unlock(&port->mutex);
1644 	goto end;
1645 }
1646 
1647 static const char *uart_type(struct uart_port *port)
1648 {
1649 	const char *str = NULL;
1650 
1651 	if (port->ops->type)
1652 		str = port->ops->type(port);
1653 
1654 	if (!str)
1655 		str = "unknown";
1656 
1657 	return str;
1658 }
1659 
1660 #ifdef CONFIG_PROC_FS
1661 
1662 static void uart_line_info(struct seq_file *m, struct uart_driver *drv, int i)
1663 {
1664 	struct uart_state *state = drv->state + i;
1665 	struct tty_port *port = &state->port;
1666 	enum uart_pm_state pm_state;
1667 	struct uart_port *uport = state->uart_port;
1668 	char stat_buf[32];
1669 	unsigned int status;
1670 	int mmio;
1671 
1672 	if (!uport)
1673 		return;
1674 
1675 	mmio = uport->iotype >= UPIO_MEM;
1676 	seq_printf(m, "%d: uart:%s %s%08llX irq:%d",
1677 			uport->line, uart_type(uport),
1678 			mmio ? "mmio:0x" : "port:",
1679 			mmio ? (unsigned long long)uport->mapbase
1680 			     : (unsigned long long)uport->iobase,
1681 			uport->irq);
1682 
1683 	if (uport->type == PORT_UNKNOWN) {
1684 		seq_putc(m, '\n');
1685 		return;
1686 	}
1687 
1688 	if (capable(CAP_SYS_ADMIN)) {
1689 		mutex_lock(&port->mutex);
1690 		pm_state = state->pm_state;
1691 		if (pm_state != UART_PM_STATE_ON)
1692 			uart_change_pm(state, UART_PM_STATE_ON);
1693 		spin_lock_irq(&uport->lock);
1694 		status = uport->ops->get_mctrl(uport);
1695 		spin_unlock_irq(&uport->lock);
1696 		if (pm_state != UART_PM_STATE_ON)
1697 			uart_change_pm(state, pm_state);
1698 		mutex_unlock(&port->mutex);
1699 
1700 		seq_printf(m, " tx:%d rx:%d",
1701 				uport->icount.tx, uport->icount.rx);
1702 		if (uport->icount.frame)
1703 			seq_printf(m, " fe:%d",
1704 				uport->icount.frame);
1705 		if (uport->icount.parity)
1706 			seq_printf(m, " pe:%d",
1707 				uport->icount.parity);
1708 		if (uport->icount.brk)
1709 			seq_printf(m, " brk:%d",
1710 				uport->icount.brk);
1711 		if (uport->icount.overrun)
1712 			seq_printf(m, " oe:%d",
1713 				uport->icount.overrun);
1714 
1715 #define INFOBIT(bit, str) \
1716 	if (uport->mctrl & (bit)) \
1717 		strncat(stat_buf, (str), sizeof(stat_buf) - \
1718 			strlen(stat_buf) - 2)
1719 #define STATBIT(bit, str) \
1720 	if (status & (bit)) \
1721 		strncat(stat_buf, (str), sizeof(stat_buf) - \
1722 		       strlen(stat_buf) - 2)
1723 
1724 		stat_buf[0] = '\0';
1725 		stat_buf[1] = '\0';
1726 		INFOBIT(TIOCM_RTS, "|RTS");
1727 		STATBIT(TIOCM_CTS, "|CTS");
1728 		INFOBIT(TIOCM_DTR, "|DTR");
1729 		STATBIT(TIOCM_DSR, "|DSR");
1730 		STATBIT(TIOCM_CAR, "|CD");
1731 		STATBIT(TIOCM_RNG, "|RI");
1732 		if (stat_buf[0])
1733 			stat_buf[0] = ' ';
1734 
1735 		seq_puts(m, stat_buf);
1736 	}
1737 	seq_putc(m, '\n');
1738 #undef STATBIT
1739 #undef INFOBIT
1740 }
1741 
1742 static int uart_proc_show(struct seq_file *m, void *v)
1743 {
1744 	struct tty_driver *ttydrv = m->private;
1745 	struct uart_driver *drv = ttydrv->driver_state;
1746 	int i;
1747 
1748 	seq_printf(m, "serinfo:1.0 driver%s%s revision:%s\n",
1749 			"", "", "");
1750 	for (i = 0; i < drv->nr; i++)
1751 		uart_line_info(m, drv, i);
1752 	return 0;
1753 }
1754 
1755 static int uart_proc_open(struct inode *inode, struct file *file)
1756 {
1757 	return single_open(file, uart_proc_show, PDE_DATA(inode));
1758 }
1759 
1760 static const struct file_operations uart_proc_fops = {
1761 	.owner		= THIS_MODULE,
1762 	.open		= uart_proc_open,
1763 	.read		= seq_read,
1764 	.llseek		= seq_lseek,
1765 	.release	= single_release,
1766 };
1767 #endif
1768 
1769 #if defined(CONFIG_SERIAL_CORE_CONSOLE) || defined(CONFIG_CONSOLE_POLL)
1770 /**
1771  *	uart_console_write - write a console message to a serial port
1772  *	@port: the port to write the message
1773  *	@s: array of characters
1774  *	@count: number of characters in string to write
1775  *	@putchar: function to write character to port
1776  */
1777 void uart_console_write(struct uart_port *port, const char *s,
1778 			unsigned int count,
1779 			void (*putchar)(struct uart_port *, int))
1780 {
1781 	unsigned int i;
1782 
1783 	for (i = 0; i < count; i++, s++) {
1784 		if (*s == '\n')
1785 			putchar(port, '\r');
1786 		putchar(port, *s);
1787 	}
1788 }
1789 EXPORT_SYMBOL_GPL(uart_console_write);
1790 
1791 /*
1792  *	Check whether an invalid uart number has been specified, and
1793  *	if so, search for the first available port that does have
1794  *	console support.
1795  */
1796 struct uart_port * __init
1797 uart_get_console(struct uart_port *ports, int nr, struct console *co)
1798 {
1799 	int idx = co->index;
1800 
1801 	if (idx < 0 || idx >= nr || (ports[idx].iobase == 0 &&
1802 				     ports[idx].membase == NULL))
1803 		for (idx = 0; idx < nr; idx++)
1804 			if (ports[idx].iobase != 0 ||
1805 			    ports[idx].membase != NULL)
1806 				break;
1807 
1808 	co->index = idx;
1809 
1810 	return ports + idx;
1811 }
1812 
1813 /**
1814  *	uart_parse_earlycon - Parse earlycon options
1815  *	@p:	  ptr to 2nd field (ie., just beyond '<name>,')
1816  *	@iotype:  ptr for decoded iotype (out)
1817  *	@addr:    ptr for decoded mapbase/iobase (out)
1818  *	@options: ptr for <options> field; NULL if not present (out)
1819  *
1820  *	Decodes earlycon kernel command line parameters of the form
1821  *	   earlycon=<name>,io|mmio|mmio32|mmio32be|mmio32native,<addr>,<options>
1822  *	   console=<name>,io|mmio|mmio32|mmio32be|mmio32native,<addr>,<options>
1823  *
1824  *	The optional form
1825  *	   earlycon=<name>,0x<addr>,<options>
1826  *	   console=<name>,0x<addr>,<options>
1827  *	is also accepted; the returned @iotype will be UPIO_MEM.
1828  *
1829  *	Returns 0 on success or -EINVAL on failure
1830  */
1831 int uart_parse_earlycon(char *p, unsigned char *iotype, unsigned long *addr,
1832 			char **options)
1833 {
1834 	if (strncmp(p, "mmio,", 5) == 0) {
1835 		*iotype = UPIO_MEM;
1836 		p += 5;
1837 	} else if (strncmp(p, "mmio32,", 7) == 0) {
1838 		*iotype = UPIO_MEM32;
1839 		p += 7;
1840 	} else if (strncmp(p, "mmio32be,", 9) == 0) {
1841 		*iotype = UPIO_MEM32BE;
1842 		p += 9;
1843 	} else if (strncmp(p, "mmio32native,", 13) == 0) {
1844 		*iotype = IS_ENABLED(CONFIG_CPU_BIG_ENDIAN) ?
1845 			UPIO_MEM32BE : UPIO_MEM32;
1846 		p += 13;
1847 	} else if (strncmp(p, "io,", 3) == 0) {
1848 		*iotype = UPIO_PORT;
1849 		p += 3;
1850 	} else if (strncmp(p, "0x", 2) == 0) {
1851 		*iotype = UPIO_MEM;
1852 	} else {
1853 		return -EINVAL;
1854 	}
1855 
1856 	*addr = simple_strtoul(p, NULL, 0);
1857 	p = strchr(p, ',');
1858 	if (p)
1859 		p++;
1860 
1861 	*options = p;
1862 	return 0;
1863 }
1864 EXPORT_SYMBOL_GPL(uart_parse_earlycon);
1865 
1866 /**
1867  *	uart_parse_options - Parse serial port baud/parity/bits/flow control.
1868  *	@options: pointer to option string
1869  *	@baud: pointer to an 'int' variable for the baud rate.
1870  *	@parity: pointer to an 'int' variable for the parity.
1871  *	@bits: pointer to an 'int' variable for the number of data bits.
1872  *	@flow: pointer to an 'int' variable for the flow control character.
1873  *
1874  *	uart_parse_options decodes a string containing the serial console
1875  *	options.  The format of the string is <baud><parity><bits><flow>,
1876  *	eg: 115200n8r
1877  */
1878 void
1879 uart_parse_options(char *options, int *baud, int *parity, int *bits, int *flow)
1880 {
1881 	char *s = options;
1882 
1883 	*baud = simple_strtoul(s, NULL, 10);
1884 	while (*s >= '0' && *s <= '9')
1885 		s++;
1886 	if (*s)
1887 		*parity = *s++;
1888 	if (*s)
1889 		*bits = *s++ - '0';
1890 	if (*s)
1891 		*flow = *s;
1892 }
1893 EXPORT_SYMBOL_GPL(uart_parse_options);
1894 
1895 struct baud_rates {
1896 	unsigned int rate;
1897 	unsigned int cflag;
1898 };
1899 
1900 static const struct baud_rates baud_rates[] = {
1901 	{ 921600, B921600 },
1902 	{ 460800, B460800 },
1903 	{ 230400, B230400 },
1904 	{ 115200, B115200 },
1905 	{  57600, B57600  },
1906 	{  38400, B38400  },
1907 	{  19200, B19200  },
1908 	{   9600, B9600   },
1909 	{   4800, B4800   },
1910 	{   2400, B2400   },
1911 	{   1200, B1200   },
1912 	{      0, B38400  }
1913 };
1914 
1915 /**
1916  *	uart_set_options - setup the serial console parameters
1917  *	@port: pointer to the serial ports uart_port structure
1918  *	@co: console pointer
1919  *	@baud: baud rate
1920  *	@parity: parity character - 'n' (none), 'o' (odd), 'e' (even)
1921  *	@bits: number of data bits
1922  *	@flow: flow control character - 'r' (rts)
1923  */
1924 int
1925 uart_set_options(struct uart_port *port, struct console *co,
1926 		 int baud, int parity, int bits, int flow)
1927 {
1928 	struct ktermios termios;
1929 	static struct ktermios dummy;
1930 	int i;
1931 
1932 	/*
1933 	 * Ensure that the serial console lock is initialised
1934 	 * early.
1935 	 * If this port is a console, then the spinlock is already
1936 	 * initialised.
1937 	 */
1938 	if (!(uart_console(port) && (port->cons->flags & CON_ENABLED))) {
1939 		spin_lock_init(&port->lock);
1940 		lockdep_set_class(&port->lock, &port_lock_key);
1941 	}
1942 
1943 	memset(&termios, 0, sizeof(struct ktermios));
1944 
1945 	termios.c_cflag = CREAD | HUPCL | CLOCAL;
1946 
1947 	/*
1948 	 * Construct a cflag setting.
1949 	 */
1950 	for (i = 0; baud_rates[i].rate; i++)
1951 		if (baud_rates[i].rate <= baud)
1952 			break;
1953 
1954 	termios.c_cflag |= baud_rates[i].cflag;
1955 
1956 	if (bits == 7)
1957 		termios.c_cflag |= CS7;
1958 	else
1959 		termios.c_cflag |= CS8;
1960 
1961 	switch (parity) {
1962 	case 'o': case 'O':
1963 		termios.c_cflag |= PARODD;
1964 		/*fall through*/
1965 	case 'e': case 'E':
1966 		termios.c_cflag |= PARENB;
1967 		break;
1968 	}
1969 
1970 	if (flow == 'r')
1971 		termios.c_cflag |= CRTSCTS;
1972 
1973 	/*
1974 	 * some uarts on other side don't support no flow control.
1975 	 * So we set * DTR in host uart to make them happy
1976 	 */
1977 	port->mctrl |= TIOCM_DTR;
1978 
1979 	port->ops->set_termios(port, &termios, &dummy);
1980 	/*
1981 	 * Allow the setting of the UART parameters with a NULL console
1982 	 * too:
1983 	 */
1984 	if (co)
1985 		co->cflag = termios.c_cflag;
1986 
1987 	return 0;
1988 }
1989 EXPORT_SYMBOL_GPL(uart_set_options);
1990 #endif /* CONFIG_SERIAL_CORE_CONSOLE */
1991 
1992 /**
1993  * uart_change_pm - set power state of the port
1994  *
1995  * @state: port descriptor
1996  * @pm_state: new state
1997  *
1998  * Locking: port->mutex has to be held
1999  */
2000 static void uart_change_pm(struct uart_state *state,
2001 			   enum uart_pm_state pm_state)
2002 {
2003 	struct uart_port *port = state->uart_port;
2004 
2005 	if (state->pm_state != pm_state) {
2006 		if (port->ops->pm)
2007 			port->ops->pm(port, pm_state, state->pm_state);
2008 		state->pm_state = pm_state;
2009 	}
2010 }
2011 
2012 struct uart_match {
2013 	struct uart_port *port;
2014 	struct uart_driver *driver;
2015 };
2016 
2017 static int serial_match_port(struct device *dev, void *data)
2018 {
2019 	struct uart_match *match = data;
2020 	struct tty_driver *tty_drv = match->driver->tty_driver;
2021 	dev_t devt = MKDEV(tty_drv->major, tty_drv->minor_start) +
2022 		match->port->line;
2023 
2024 	return dev->devt == devt; /* Actually, only one tty per port */
2025 }
2026 
2027 int uart_suspend_port(struct uart_driver *drv, struct uart_port *uport)
2028 {
2029 	struct uart_state *state = drv->state + uport->line;
2030 	struct tty_port *port = &state->port;
2031 	struct device *tty_dev;
2032 	struct uart_match match = {uport, drv};
2033 
2034 	mutex_lock(&port->mutex);
2035 
2036 	tty_dev = device_find_child(uport->dev, &match, serial_match_port);
2037 	if (device_may_wakeup(tty_dev)) {
2038 		if (!enable_irq_wake(uport->irq))
2039 			uport->irq_wake = 1;
2040 		put_device(tty_dev);
2041 		mutex_unlock(&port->mutex);
2042 		return 0;
2043 	}
2044 	put_device(tty_dev);
2045 
2046 	/* Nothing to do if the console is not suspending */
2047 	if (!console_suspend_enabled && uart_console(uport))
2048 		goto unlock;
2049 
2050 	uport->suspended = 1;
2051 
2052 	if (port->flags & ASYNC_INITIALIZED) {
2053 		const struct uart_ops *ops = uport->ops;
2054 		int tries;
2055 
2056 		set_bit(ASYNCB_SUSPENDED, &port->flags);
2057 		clear_bit(ASYNCB_INITIALIZED, &port->flags);
2058 
2059 		spin_lock_irq(&uport->lock);
2060 		ops->stop_tx(uport);
2061 		ops->set_mctrl(uport, 0);
2062 		ops->stop_rx(uport);
2063 		spin_unlock_irq(&uport->lock);
2064 
2065 		/*
2066 		 * Wait for the transmitter to empty.
2067 		 */
2068 		for (tries = 3; !ops->tx_empty(uport) && tries; tries--)
2069 			msleep(10);
2070 		if (!tries)
2071 			dev_err(uport->dev, "%s%d: Unable to drain transmitter\n",
2072 				drv->dev_name,
2073 				drv->tty_driver->name_base + uport->line);
2074 
2075 		ops->shutdown(uport);
2076 	}
2077 
2078 	/*
2079 	 * Disable the console device before suspending.
2080 	 */
2081 	if (uart_console(uport))
2082 		console_stop(uport->cons);
2083 
2084 	uart_change_pm(state, UART_PM_STATE_OFF);
2085 unlock:
2086 	mutex_unlock(&port->mutex);
2087 
2088 	return 0;
2089 }
2090 
2091 int uart_resume_port(struct uart_driver *drv, struct uart_port *uport)
2092 {
2093 	struct uart_state *state = drv->state + uport->line;
2094 	struct tty_port *port = &state->port;
2095 	struct device *tty_dev;
2096 	struct uart_match match = {uport, drv};
2097 	struct ktermios termios;
2098 
2099 	mutex_lock(&port->mutex);
2100 
2101 	tty_dev = device_find_child(uport->dev, &match, serial_match_port);
2102 	if (!uport->suspended && device_may_wakeup(tty_dev)) {
2103 		if (uport->irq_wake) {
2104 			disable_irq_wake(uport->irq);
2105 			uport->irq_wake = 0;
2106 		}
2107 		put_device(tty_dev);
2108 		mutex_unlock(&port->mutex);
2109 		return 0;
2110 	}
2111 	put_device(tty_dev);
2112 	uport->suspended = 0;
2113 
2114 	/*
2115 	 * Re-enable the console device after suspending.
2116 	 */
2117 	if (uart_console(uport)) {
2118 		/*
2119 		 * First try to use the console cflag setting.
2120 		 */
2121 		memset(&termios, 0, sizeof(struct ktermios));
2122 		termios.c_cflag = uport->cons->cflag;
2123 
2124 		/*
2125 		 * If that's unset, use the tty termios setting.
2126 		 */
2127 		if (port->tty && termios.c_cflag == 0)
2128 			termios = port->tty->termios;
2129 
2130 		if (console_suspend_enabled)
2131 			uart_change_pm(state, UART_PM_STATE_ON);
2132 		uport->ops->set_termios(uport, &termios, NULL);
2133 		if (console_suspend_enabled)
2134 			console_start(uport->cons);
2135 	}
2136 
2137 	if (port->flags & ASYNC_SUSPENDED) {
2138 		const struct uart_ops *ops = uport->ops;
2139 		int ret;
2140 
2141 		uart_change_pm(state, UART_PM_STATE_ON);
2142 		spin_lock_irq(&uport->lock);
2143 		ops->set_mctrl(uport, 0);
2144 		spin_unlock_irq(&uport->lock);
2145 		if (console_suspend_enabled || !uart_console(uport)) {
2146 			/* Protected by port mutex for now */
2147 			struct tty_struct *tty = port->tty;
2148 			ret = ops->startup(uport);
2149 			if (ret == 0) {
2150 				if (tty)
2151 					uart_change_speed(tty, state, NULL);
2152 				spin_lock_irq(&uport->lock);
2153 				ops->set_mctrl(uport, uport->mctrl);
2154 				ops->start_tx(uport);
2155 				spin_unlock_irq(&uport->lock);
2156 				set_bit(ASYNCB_INITIALIZED, &port->flags);
2157 			} else {
2158 				/*
2159 				 * Failed to resume - maybe hardware went away?
2160 				 * Clear the "initialized" flag so we won't try
2161 				 * to call the low level drivers shutdown method.
2162 				 */
2163 				uart_shutdown(tty, state);
2164 			}
2165 		}
2166 
2167 		clear_bit(ASYNCB_SUSPENDED, &port->flags);
2168 	}
2169 
2170 	mutex_unlock(&port->mutex);
2171 
2172 	return 0;
2173 }
2174 
2175 static inline void
2176 uart_report_port(struct uart_driver *drv, struct uart_port *port)
2177 {
2178 	char address[64];
2179 
2180 	switch (port->iotype) {
2181 	case UPIO_PORT:
2182 		snprintf(address, sizeof(address), "I/O 0x%lx", port->iobase);
2183 		break;
2184 	case UPIO_HUB6:
2185 		snprintf(address, sizeof(address),
2186 			 "I/O 0x%lx offset 0x%x", port->iobase, port->hub6);
2187 		break;
2188 	case UPIO_MEM:
2189 	case UPIO_MEM32:
2190 	case UPIO_MEM32BE:
2191 	case UPIO_AU:
2192 	case UPIO_TSI:
2193 		snprintf(address, sizeof(address),
2194 			 "MMIO 0x%llx", (unsigned long long)port->mapbase);
2195 		break;
2196 	default:
2197 		strlcpy(address, "*unknown*", sizeof(address));
2198 		break;
2199 	}
2200 
2201 	printk(KERN_INFO "%s%s%s%d at %s (irq = %d, base_baud = %d) is a %s\n",
2202 	       port->dev ? dev_name(port->dev) : "",
2203 	       port->dev ? ": " : "",
2204 	       drv->dev_name,
2205 	       drv->tty_driver->name_base + port->line,
2206 	       address, port->irq, port->uartclk / 16, uart_type(port));
2207 }
2208 
2209 static void
2210 uart_configure_port(struct uart_driver *drv, struct uart_state *state,
2211 		    struct uart_port *port)
2212 {
2213 	unsigned int flags;
2214 
2215 	/*
2216 	 * If there isn't a port here, don't do anything further.
2217 	 */
2218 	if (!port->iobase && !port->mapbase && !port->membase)
2219 		return;
2220 
2221 	/*
2222 	 * Now do the auto configuration stuff.  Note that config_port
2223 	 * is expected to claim the resources and map the port for us.
2224 	 */
2225 	flags = 0;
2226 	if (port->flags & UPF_AUTO_IRQ)
2227 		flags |= UART_CONFIG_IRQ;
2228 	if (port->flags & UPF_BOOT_AUTOCONF) {
2229 		if (!(port->flags & UPF_FIXED_TYPE)) {
2230 			port->type = PORT_UNKNOWN;
2231 			flags |= UART_CONFIG_TYPE;
2232 		}
2233 		port->ops->config_port(port, flags);
2234 	}
2235 
2236 	if (port->type != PORT_UNKNOWN) {
2237 		unsigned long flags;
2238 
2239 		uart_report_port(drv, port);
2240 
2241 		/* Power up port for set_mctrl() */
2242 		uart_change_pm(state, UART_PM_STATE_ON);
2243 
2244 		/*
2245 		 * Ensure that the modem control lines are de-activated.
2246 		 * keep the DTR setting that is set in uart_set_options()
2247 		 * We probably don't need a spinlock around this, but
2248 		 */
2249 		spin_lock_irqsave(&port->lock, flags);
2250 		port->ops->set_mctrl(port, port->mctrl & TIOCM_DTR);
2251 		spin_unlock_irqrestore(&port->lock, flags);
2252 
2253 		/*
2254 		 * If this driver supports console, and it hasn't been
2255 		 * successfully registered yet, try to re-register it.
2256 		 * It may be that the port was not available.
2257 		 */
2258 		if (port->cons && !(port->cons->flags & CON_ENABLED))
2259 			register_console(port->cons);
2260 
2261 		/*
2262 		 * Power down all ports by default, except the
2263 		 * console if we have one.
2264 		 */
2265 		if (!uart_console(port))
2266 			uart_change_pm(state, UART_PM_STATE_OFF);
2267 	}
2268 }
2269 
2270 #ifdef CONFIG_CONSOLE_POLL
2271 
2272 static int uart_poll_init(struct tty_driver *driver, int line, char *options)
2273 {
2274 	struct uart_driver *drv = driver->driver_state;
2275 	struct uart_state *state = drv->state + line;
2276 	struct uart_port *port;
2277 	int baud = 9600;
2278 	int bits = 8;
2279 	int parity = 'n';
2280 	int flow = 'n';
2281 	int ret;
2282 
2283 	if (!state || !state->uart_port)
2284 		return -1;
2285 
2286 	port = state->uart_port;
2287 	if (!(port->ops->poll_get_char && port->ops->poll_put_char))
2288 		return -1;
2289 
2290 	if (port->ops->poll_init) {
2291 		struct tty_port *tport = &state->port;
2292 
2293 		ret = 0;
2294 		mutex_lock(&tport->mutex);
2295 		/*
2296 		 * We don't set ASYNCB_INITIALIZED as we only initialized the
2297 		 * hw, e.g. state->xmit is still uninitialized.
2298 		 */
2299 		if (!test_bit(ASYNCB_INITIALIZED, &tport->flags))
2300 			ret = port->ops->poll_init(port);
2301 		mutex_unlock(&tport->mutex);
2302 		if (ret)
2303 			return ret;
2304 	}
2305 
2306 	if (options) {
2307 		uart_parse_options(options, &baud, &parity, &bits, &flow);
2308 		return uart_set_options(port, NULL, baud, parity, bits, flow);
2309 	}
2310 
2311 	return 0;
2312 }
2313 
2314 static int uart_poll_get_char(struct tty_driver *driver, int line)
2315 {
2316 	struct uart_driver *drv = driver->driver_state;
2317 	struct uart_state *state = drv->state + line;
2318 	struct uart_port *port;
2319 
2320 	if (!state || !state->uart_port)
2321 		return -1;
2322 
2323 	port = state->uart_port;
2324 	return port->ops->poll_get_char(port);
2325 }
2326 
2327 static void uart_poll_put_char(struct tty_driver *driver, int line, char ch)
2328 {
2329 	struct uart_driver *drv = driver->driver_state;
2330 	struct uart_state *state = drv->state + line;
2331 	struct uart_port *port;
2332 
2333 	if (!state || !state->uart_port)
2334 		return;
2335 
2336 	port = state->uart_port;
2337 
2338 	if (ch == '\n')
2339 		port->ops->poll_put_char(port, '\r');
2340 	port->ops->poll_put_char(port, ch);
2341 }
2342 #endif
2343 
2344 static const struct tty_operations uart_ops = {
2345 	.open		= uart_open,
2346 	.close		= uart_close,
2347 	.write		= uart_write,
2348 	.put_char	= uart_put_char,
2349 	.flush_chars	= uart_flush_chars,
2350 	.write_room	= uart_write_room,
2351 	.chars_in_buffer= uart_chars_in_buffer,
2352 	.flush_buffer	= uart_flush_buffer,
2353 	.ioctl		= uart_ioctl,
2354 	.throttle	= uart_throttle,
2355 	.unthrottle	= uart_unthrottle,
2356 	.send_xchar	= uart_send_xchar,
2357 	.set_termios	= uart_set_termios,
2358 	.set_ldisc	= uart_set_ldisc,
2359 	.stop		= uart_stop,
2360 	.start		= uart_start,
2361 	.hangup		= uart_hangup,
2362 	.break_ctl	= uart_break_ctl,
2363 	.wait_until_sent= uart_wait_until_sent,
2364 #ifdef CONFIG_PROC_FS
2365 	.proc_fops	= &uart_proc_fops,
2366 #endif
2367 	.tiocmget	= uart_tiocmget,
2368 	.tiocmset	= uart_tiocmset,
2369 	.get_icount	= uart_get_icount,
2370 #ifdef CONFIG_CONSOLE_POLL
2371 	.poll_init	= uart_poll_init,
2372 	.poll_get_char	= uart_poll_get_char,
2373 	.poll_put_char	= uart_poll_put_char,
2374 #endif
2375 };
2376 
2377 static const struct tty_port_operations uart_port_ops = {
2378 	.carrier_raised = uart_carrier_raised,
2379 	.dtr_rts	= uart_dtr_rts,
2380 };
2381 
2382 /**
2383  *	uart_register_driver - register a driver with the uart core layer
2384  *	@drv: low level driver structure
2385  *
2386  *	Register a uart driver with the core driver.  We in turn register
2387  *	with the tty layer, and initialise the core driver per-port state.
2388  *
2389  *	We have a proc file in /proc/tty/driver which is named after the
2390  *	normal driver.
2391  *
2392  *	drv->port should be NULL, and the per-port structures should be
2393  *	registered using uart_add_one_port after this call has succeeded.
2394  */
2395 int uart_register_driver(struct uart_driver *drv)
2396 {
2397 	struct tty_driver *normal;
2398 	int i, retval;
2399 
2400 	BUG_ON(drv->state);
2401 
2402 	/*
2403 	 * Maybe we should be using a slab cache for this, especially if
2404 	 * we have a large number of ports to handle.
2405 	 */
2406 	drv->state = kzalloc(sizeof(struct uart_state) * drv->nr, GFP_KERNEL);
2407 	if (!drv->state)
2408 		goto out;
2409 
2410 	normal = alloc_tty_driver(drv->nr);
2411 	if (!normal)
2412 		goto out_kfree;
2413 
2414 	drv->tty_driver = normal;
2415 
2416 	normal->driver_name	= drv->driver_name;
2417 	normal->name		= drv->dev_name;
2418 	normal->major		= drv->major;
2419 	normal->minor_start	= drv->minor;
2420 	normal->type		= TTY_DRIVER_TYPE_SERIAL;
2421 	normal->subtype		= SERIAL_TYPE_NORMAL;
2422 	normal->init_termios	= tty_std_termios;
2423 	normal->init_termios.c_cflag = B9600 | CS8 | CREAD | HUPCL | CLOCAL;
2424 	normal->init_termios.c_ispeed = normal->init_termios.c_ospeed = 9600;
2425 	normal->flags		= TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
2426 	normal->driver_state    = drv;
2427 	tty_set_operations(normal, &uart_ops);
2428 
2429 	/*
2430 	 * Initialise the UART state(s).
2431 	 */
2432 	for (i = 0; i < drv->nr; i++) {
2433 		struct uart_state *state = drv->state + i;
2434 		struct tty_port *port = &state->port;
2435 
2436 		tty_port_init(port);
2437 		port->ops = &uart_port_ops;
2438 	}
2439 
2440 	retval = tty_register_driver(normal);
2441 	if (retval >= 0)
2442 		return retval;
2443 
2444 	for (i = 0; i < drv->nr; i++)
2445 		tty_port_destroy(&drv->state[i].port);
2446 	put_tty_driver(normal);
2447 out_kfree:
2448 	kfree(drv->state);
2449 out:
2450 	return -ENOMEM;
2451 }
2452 
2453 /**
2454  *	uart_unregister_driver - remove a driver from the uart core layer
2455  *	@drv: low level driver structure
2456  *
2457  *	Remove all references to a driver from the core driver.  The low
2458  *	level driver must have removed all its ports via the
2459  *	uart_remove_one_port() if it registered them with uart_add_one_port().
2460  *	(ie, drv->port == NULL)
2461  */
2462 void uart_unregister_driver(struct uart_driver *drv)
2463 {
2464 	struct tty_driver *p = drv->tty_driver;
2465 	unsigned int i;
2466 
2467 	tty_unregister_driver(p);
2468 	put_tty_driver(p);
2469 	for (i = 0; i < drv->nr; i++)
2470 		tty_port_destroy(&drv->state[i].port);
2471 	kfree(drv->state);
2472 	drv->state = NULL;
2473 	drv->tty_driver = NULL;
2474 }
2475 
2476 struct tty_driver *uart_console_device(struct console *co, int *index)
2477 {
2478 	struct uart_driver *p = co->data;
2479 	*index = co->index;
2480 	return p->tty_driver;
2481 }
2482 
2483 static ssize_t uart_get_attr_uartclk(struct device *dev,
2484 	struct device_attribute *attr, char *buf)
2485 {
2486 	struct serial_struct tmp;
2487 	struct tty_port *port = dev_get_drvdata(dev);
2488 
2489 	uart_get_info(port, &tmp);
2490 	return snprintf(buf, PAGE_SIZE, "%d\n", tmp.baud_base * 16);
2491 }
2492 
2493 static ssize_t uart_get_attr_type(struct device *dev,
2494 	struct device_attribute *attr, char *buf)
2495 {
2496 	struct serial_struct tmp;
2497 	struct tty_port *port = dev_get_drvdata(dev);
2498 
2499 	uart_get_info(port, &tmp);
2500 	return snprintf(buf, PAGE_SIZE, "%d\n", tmp.type);
2501 }
2502 static ssize_t uart_get_attr_line(struct device *dev,
2503 	struct device_attribute *attr, char *buf)
2504 {
2505 	struct serial_struct tmp;
2506 	struct tty_port *port = dev_get_drvdata(dev);
2507 
2508 	uart_get_info(port, &tmp);
2509 	return snprintf(buf, PAGE_SIZE, "%d\n", tmp.line);
2510 }
2511 
2512 static ssize_t uart_get_attr_port(struct device *dev,
2513 	struct device_attribute *attr, char *buf)
2514 {
2515 	struct serial_struct tmp;
2516 	struct tty_port *port = dev_get_drvdata(dev);
2517 	unsigned long ioaddr;
2518 
2519 	uart_get_info(port, &tmp);
2520 	ioaddr = tmp.port;
2521 	if (HIGH_BITS_OFFSET)
2522 		ioaddr |= (unsigned long)tmp.port_high << HIGH_BITS_OFFSET;
2523 	return snprintf(buf, PAGE_SIZE, "0x%lX\n", ioaddr);
2524 }
2525 
2526 static ssize_t uart_get_attr_irq(struct device *dev,
2527 	struct device_attribute *attr, char *buf)
2528 {
2529 	struct serial_struct tmp;
2530 	struct tty_port *port = dev_get_drvdata(dev);
2531 
2532 	uart_get_info(port, &tmp);
2533 	return snprintf(buf, PAGE_SIZE, "%d\n", tmp.irq);
2534 }
2535 
2536 static ssize_t uart_get_attr_flags(struct device *dev,
2537 	struct device_attribute *attr, char *buf)
2538 {
2539 	struct serial_struct tmp;
2540 	struct tty_port *port = dev_get_drvdata(dev);
2541 
2542 	uart_get_info(port, &tmp);
2543 	return snprintf(buf, PAGE_SIZE, "0x%X\n", tmp.flags);
2544 }
2545 
2546 static ssize_t uart_get_attr_xmit_fifo_size(struct device *dev,
2547 	struct device_attribute *attr, char *buf)
2548 {
2549 	struct serial_struct tmp;
2550 	struct tty_port *port = dev_get_drvdata(dev);
2551 
2552 	uart_get_info(port, &tmp);
2553 	return snprintf(buf, PAGE_SIZE, "%d\n", tmp.xmit_fifo_size);
2554 }
2555 
2556 
2557 static ssize_t uart_get_attr_close_delay(struct device *dev,
2558 	struct device_attribute *attr, char *buf)
2559 {
2560 	struct serial_struct tmp;
2561 	struct tty_port *port = dev_get_drvdata(dev);
2562 
2563 	uart_get_info(port, &tmp);
2564 	return snprintf(buf, PAGE_SIZE, "%d\n", tmp.close_delay);
2565 }
2566 
2567 
2568 static ssize_t uart_get_attr_closing_wait(struct device *dev,
2569 	struct device_attribute *attr, char *buf)
2570 {
2571 	struct serial_struct tmp;
2572 	struct tty_port *port = dev_get_drvdata(dev);
2573 
2574 	uart_get_info(port, &tmp);
2575 	return snprintf(buf, PAGE_SIZE, "%d\n", tmp.closing_wait);
2576 }
2577 
2578 static ssize_t uart_get_attr_custom_divisor(struct device *dev,
2579 	struct device_attribute *attr, char *buf)
2580 {
2581 	struct serial_struct tmp;
2582 	struct tty_port *port = dev_get_drvdata(dev);
2583 
2584 	uart_get_info(port, &tmp);
2585 	return snprintf(buf, PAGE_SIZE, "%d\n", tmp.custom_divisor);
2586 }
2587 
2588 static ssize_t uart_get_attr_io_type(struct device *dev,
2589 	struct device_attribute *attr, char *buf)
2590 {
2591 	struct serial_struct tmp;
2592 	struct tty_port *port = dev_get_drvdata(dev);
2593 
2594 	uart_get_info(port, &tmp);
2595 	return snprintf(buf, PAGE_SIZE, "%d\n", tmp.io_type);
2596 }
2597 
2598 static ssize_t uart_get_attr_iomem_base(struct device *dev,
2599 	struct device_attribute *attr, char *buf)
2600 {
2601 	struct serial_struct tmp;
2602 	struct tty_port *port = dev_get_drvdata(dev);
2603 
2604 	uart_get_info(port, &tmp);
2605 	return snprintf(buf, PAGE_SIZE, "0x%lX\n", (unsigned long)tmp.iomem_base);
2606 }
2607 
2608 static ssize_t uart_get_attr_iomem_reg_shift(struct device *dev,
2609 	struct device_attribute *attr, char *buf)
2610 {
2611 	struct serial_struct tmp;
2612 	struct tty_port *port = dev_get_drvdata(dev);
2613 
2614 	uart_get_info(port, &tmp);
2615 	return snprintf(buf, PAGE_SIZE, "%d\n", tmp.iomem_reg_shift);
2616 }
2617 
2618 static DEVICE_ATTR(type, S_IRUSR | S_IRGRP, uart_get_attr_type, NULL);
2619 static DEVICE_ATTR(line, S_IRUSR | S_IRGRP, uart_get_attr_line, NULL);
2620 static DEVICE_ATTR(port, S_IRUSR | S_IRGRP, uart_get_attr_port, NULL);
2621 static DEVICE_ATTR(irq, S_IRUSR | S_IRGRP, uart_get_attr_irq, NULL);
2622 static DEVICE_ATTR(flags, S_IRUSR | S_IRGRP, uart_get_attr_flags, NULL);
2623 static DEVICE_ATTR(xmit_fifo_size, S_IRUSR | S_IRGRP, uart_get_attr_xmit_fifo_size, NULL);
2624 static DEVICE_ATTR(uartclk, S_IRUSR | S_IRGRP, uart_get_attr_uartclk, NULL);
2625 static DEVICE_ATTR(close_delay, S_IRUSR | S_IRGRP, uart_get_attr_close_delay, NULL);
2626 static DEVICE_ATTR(closing_wait, S_IRUSR | S_IRGRP, uart_get_attr_closing_wait, NULL);
2627 static DEVICE_ATTR(custom_divisor, S_IRUSR | S_IRGRP, uart_get_attr_custom_divisor, NULL);
2628 static DEVICE_ATTR(io_type, S_IRUSR | S_IRGRP, uart_get_attr_io_type, NULL);
2629 static DEVICE_ATTR(iomem_base, S_IRUSR | S_IRGRP, uart_get_attr_iomem_base, NULL);
2630 static DEVICE_ATTR(iomem_reg_shift, S_IRUSR | S_IRGRP, uart_get_attr_iomem_reg_shift, NULL);
2631 
2632 static struct attribute *tty_dev_attrs[] = {
2633 	&dev_attr_type.attr,
2634 	&dev_attr_line.attr,
2635 	&dev_attr_port.attr,
2636 	&dev_attr_irq.attr,
2637 	&dev_attr_flags.attr,
2638 	&dev_attr_xmit_fifo_size.attr,
2639 	&dev_attr_uartclk.attr,
2640 	&dev_attr_close_delay.attr,
2641 	&dev_attr_closing_wait.attr,
2642 	&dev_attr_custom_divisor.attr,
2643 	&dev_attr_io_type.attr,
2644 	&dev_attr_iomem_base.attr,
2645 	&dev_attr_iomem_reg_shift.attr,
2646 	NULL,
2647 	};
2648 
2649 static const struct attribute_group tty_dev_attr_group = {
2650 	.attrs = tty_dev_attrs,
2651 	};
2652 
2653 /**
2654  *	uart_add_one_port - attach a driver-defined port structure
2655  *	@drv: pointer to the uart low level driver structure for this port
2656  *	@uport: uart port structure to use for this port.
2657  *
2658  *	This allows the driver to register its own uart_port structure
2659  *	with the core driver.  The main purpose is to allow the low
2660  *	level uart drivers to expand uart_port, rather than having yet
2661  *	more levels of structures.
2662  */
2663 int uart_add_one_port(struct uart_driver *drv, struct uart_port *uport)
2664 {
2665 	struct uart_state *state;
2666 	struct tty_port *port;
2667 	int ret = 0;
2668 	struct device *tty_dev;
2669 	int num_groups;
2670 
2671 	BUG_ON(in_interrupt());
2672 
2673 	if (uport->line >= drv->nr)
2674 		return -EINVAL;
2675 
2676 	state = drv->state + uport->line;
2677 	port = &state->port;
2678 
2679 	mutex_lock(&port_mutex);
2680 	mutex_lock(&port->mutex);
2681 	if (state->uart_port) {
2682 		ret = -EINVAL;
2683 		goto out;
2684 	}
2685 
2686 	/* Link the port to the driver state table and vice versa */
2687 	state->uart_port = uport;
2688 	uport->state = state;
2689 
2690 	state->pm_state = UART_PM_STATE_UNDEFINED;
2691 	uport->cons = drv->cons;
2692 	uport->minor = drv->tty_driver->minor_start + uport->line;
2693 
2694 	/*
2695 	 * If this port is a console, then the spinlock is already
2696 	 * initialised.
2697 	 */
2698 	if (!(uart_console(uport) && (uport->cons->flags & CON_ENABLED))) {
2699 		spin_lock_init(&uport->lock);
2700 		lockdep_set_class(&uport->lock, &port_lock_key);
2701 	}
2702 	if (uport->cons && uport->dev)
2703 		of_console_check(uport->dev->of_node, uport->cons->name, uport->line);
2704 
2705 	uart_configure_port(drv, state, uport);
2706 
2707 	num_groups = 2;
2708 	if (uport->attr_group)
2709 		num_groups++;
2710 
2711 	uport->tty_groups = kcalloc(num_groups, sizeof(*uport->tty_groups),
2712 				    GFP_KERNEL);
2713 	if (!uport->tty_groups) {
2714 		ret = -ENOMEM;
2715 		goto out;
2716 	}
2717 	uport->tty_groups[0] = &tty_dev_attr_group;
2718 	if (uport->attr_group)
2719 		uport->tty_groups[1] = uport->attr_group;
2720 
2721 	/*
2722 	 * Register the port whether it's detected or not.  This allows
2723 	 * setserial to be used to alter this port's parameters.
2724 	 */
2725 	tty_dev = tty_port_register_device_attr(port, drv->tty_driver,
2726 			uport->line, uport->dev, port, uport->tty_groups);
2727 	if (likely(!IS_ERR(tty_dev))) {
2728 		device_set_wakeup_capable(tty_dev, 1);
2729 	} else {
2730 		dev_err(uport->dev, "Cannot register tty device on line %d\n",
2731 		       uport->line);
2732 	}
2733 
2734 	/*
2735 	 * Ensure UPF_DEAD is not set.
2736 	 */
2737 	uport->flags &= ~UPF_DEAD;
2738 
2739  out:
2740 	mutex_unlock(&port->mutex);
2741 	mutex_unlock(&port_mutex);
2742 
2743 	return ret;
2744 }
2745 
2746 /**
2747  *	uart_remove_one_port - detach a driver defined port structure
2748  *	@drv: pointer to the uart low level driver structure for this port
2749  *	@uport: uart port structure for this port
2750  *
2751  *	This unhooks (and hangs up) the specified port structure from the
2752  *	core driver.  No further calls will be made to the low-level code
2753  *	for this port.
2754  */
2755 int uart_remove_one_port(struct uart_driver *drv, struct uart_port *uport)
2756 {
2757 	struct uart_state *state = drv->state + uport->line;
2758 	struct tty_port *port = &state->port;
2759 	struct tty_struct *tty;
2760 	int ret = 0;
2761 
2762 	BUG_ON(in_interrupt());
2763 
2764 	if (state->uart_port != uport)
2765 		dev_alert(uport->dev, "Removing wrong port: %p != %p\n",
2766 			state->uart_port, uport);
2767 
2768 	mutex_lock(&port_mutex);
2769 
2770 	/*
2771 	 * Mark the port "dead" - this prevents any opens from
2772 	 * succeeding while we shut down the port.
2773 	 */
2774 	mutex_lock(&port->mutex);
2775 	if (!state->uart_port) {
2776 		mutex_unlock(&port->mutex);
2777 		ret = -EINVAL;
2778 		goto out;
2779 	}
2780 	uport->flags |= UPF_DEAD;
2781 	mutex_unlock(&port->mutex);
2782 
2783 	/*
2784 	 * Remove the devices from the tty layer
2785 	 */
2786 	tty_unregister_device(drv->tty_driver, uport->line);
2787 
2788 	tty = tty_port_tty_get(port);
2789 	if (tty) {
2790 		tty_vhangup(port->tty);
2791 		tty_kref_put(tty);
2792 	}
2793 
2794 	/*
2795 	 * If the port is used as a console, unregister it
2796 	 */
2797 	if (uart_console(uport))
2798 		unregister_console(uport->cons);
2799 
2800 	/*
2801 	 * Free the port IO and memory resources, if any.
2802 	 */
2803 	if (uport->type != PORT_UNKNOWN)
2804 		uport->ops->release_port(uport);
2805 	kfree(uport->tty_groups);
2806 
2807 	/*
2808 	 * Indicate that there isn't a port here anymore.
2809 	 */
2810 	uport->type = PORT_UNKNOWN;
2811 
2812 	state->uart_port = NULL;
2813 out:
2814 	mutex_unlock(&port_mutex);
2815 
2816 	return ret;
2817 }
2818 
2819 /*
2820  *	Are the two ports equivalent?
2821  */
2822 int uart_match_port(struct uart_port *port1, struct uart_port *port2)
2823 {
2824 	if (port1->iotype != port2->iotype)
2825 		return 0;
2826 
2827 	switch (port1->iotype) {
2828 	case UPIO_PORT:
2829 		return (port1->iobase == port2->iobase);
2830 	case UPIO_HUB6:
2831 		return (port1->iobase == port2->iobase) &&
2832 		       (port1->hub6   == port2->hub6);
2833 	case UPIO_MEM:
2834 	case UPIO_MEM32:
2835 	case UPIO_MEM32BE:
2836 	case UPIO_AU:
2837 	case UPIO_TSI:
2838 		return (port1->mapbase == port2->mapbase);
2839 	}
2840 	return 0;
2841 }
2842 EXPORT_SYMBOL(uart_match_port);
2843 
2844 /**
2845  *	uart_handle_dcd_change - handle a change of carrier detect state
2846  *	@uport: uart_port structure for the open port
2847  *	@status: new carrier detect status, nonzero if active
2848  *
2849  *	Caller must hold uport->lock
2850  */
2851 void uart_handle_dcd_change(struct uart_port *uport, unsigned int status)
2852 {
2853 	struct tty_port *port = &uport->state->port;
2854 	struct tty_struct *tty = port->tty;
2855 	struct tty_ldisc *ld;
2856 
2857 	lockdep_assert_held_once(&uport->lock);
2858 
2859 	if (tty) {
2860 		ld = tty_ldisc_ref(tty);
2861 		if (ld) {
2862 			if (ld->ops->dcd_change)
2863 				ld->ops->dcd_change(tty, status);
2864 			tty_ldisc_deref(ld);
2865 		}
2866 	}
2867 
2868 	uport->icount.dcd++;
2869 
2870 	if (uart_dcd_enabled(uport)) {
2871 		if (status)
2872 			wake_up_interruptible(&port->open_wait);
2873 		else if (tty)
2874 			tty_hangup(tty);
2875 	}
2876 }
2877 EXPORT_SYMBOL_GPL(uart_handle_dcd_change);
2878 
2879 /**
2880  *	uart_handle_cts_change - handle a change of clear-to-send state
2881  *	@uport: uart_port structure for the open port
2882  *	@status: new clear to send status, nonzero if active
2883  *
2884  *	Caller must hold uport->lock
2885  */
2886 void uart_handle_cts_change(struct uart_port *uport, unsigned int status)
2887 {
2888 	lockdep_assert_held_once(&uport->lock);
2889 
2890 	uport->icount.cts++;
2891 
2892 	if (uart_softcts_mode(uport)) {
2893 		if (uport->hw_stopped) {
2894 			if (status) {
2895 				uport->hw_stopped = 0;
2896 				uport->ops->start_tx(uport);
2897 				uart_write_wakeup(uport);
2898 			}
2899 		} else {
2900 			if (!status) {
2901 				uport->hw_stopped = 1;
2902 				uport->ops->stop_tx(uport);
2903 			}
2904 		}
2905 
2906 	}
2907 }
2908 EXPORT_SYMBOL_GPL(uart_handle_cts_change);
2909 
2910 /**
2911  * uart_insert_char - push a char to the uart layer
2912  *
2913  * User is responsible to call tty_flip_buffer_push when they are done with
2914  * insertion.
2915  *
2916  * @port: corresponding port
2917  * @status: state of the serial port RX buffer (LSR for 8250)
2918  * @overrun: mask of overrun bits in @status
2919  * @ch: character to push
2920  * @flag: flag for the character (see TTY_NORMAL and friends)
2921  */
2922 void uart_insert_char(struct uart_port *port, unsigned int status,
2923 		 unsigned int overrun, unsigned int ch, unsigned int flag)
2924 {
2925 	struct tty_port *tport = &port->state->port;
2926 
2927 	if ((status & port->ignore_status_mask & ~overrun) == 0)
2928 		if (tty_insert_flip_char(tport, ch, flag) == 0)
2929 			++port->icount.buf_overrun;
2930 
2931 	/*
2932 	 * Overrun is special.  Since it's reported immediately,
2933 	 * it doesn't affect the current character.
2934 	 */
2935 	if (status & ~port->ignore_status_mask & overrun)
2936 		if (tty_insert_flip_char(tport, 0, TTY_OVERRUN) == 0)
2937 			++port->icount.buf_overrun;
2938 }
2939 EXPORT_SYMBOL_GPL(uart_insert_char);
2940 
2941 EXPORT_SYMBOL(uart_write_wakeup);
2942 EXPORT_SYMBOL(uart_register_driver);
2943 EXPORT_SYMBOL(uart_unregister_driver);
2944 EXPORT_SYMBOL(uart_suspend_port);
2945 EXPORT_SYMBOL(uart_resume_port);
2946 EXPORT_SYMBOL(uart_add_one_port);
2947 EXPORT_SYMBOL(uart_remove_one_port);
2948 
2949 MODULE_DESCRIPTION("Serial driver core");
2950 MODULE_LICENSE("GPL");
2951