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