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