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