xref: /optee_os/core/drivers/serial8250_uart.c (revision bc420748bfc44a9e09000a3966fc59e9e0219df4)
1 /*
2  * Copyright (c) 2015, Linaro Limited
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright notice,
9  * this list of conditions and the following disclaimer.
10  *
11  * 2. Redistributions in binary form must reproduce the above copyright notice,
12  * this list of conditions and the following disclaimer in the documentation
13  * and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
16  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
19  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
20  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
21  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
24  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
25  * POSSIBILITY OF SUCH DAMAGE.
26  */
27 #include <platform_config.h>
28 
29 #include <drivers/serial8250_uart.h>
30 #include <console.h>
31 #include <io.h>
32 #include <assert.h>
33 #include <compiler.h>
34 
35 /* uart register defines */
36 #define UART_RHR	0x0
37 #define UART_THR	0x0
38 #define UART_IER	0x4
39 #define UART_ISR	0x8
40 #define UART_FCR	0x8
41 #define UART_LCR	0xc
42 #define UART_MCR	0x10
43 #define UART_LSR	0x14
44 #define UART_MSR	0x18
45 #define UART_SPR	0x1c
46 
47 /* uart status register bits */
48 #define LSR_TEMT	0x40 /* Transmitter empty */
49 #define LSR_THRE	0x20 /* Transmit-hold-register empty */
50 #define LSR_EMPTY	(LSR_TEMT | LSR_THRE)
51 #define LSR_DR		0x01 /* DATA Ready */
52 
53 void serial8250_uart_init(vaddr_t __unused base,
54 		uint32_t __unused uart_clk, uint32_t __unused baud_rate)
55 {
56 	/*
57 	 * do nothing, debug uart(uart0) share with normal world,
58 	 * everything for uart0 is ready now.
59 	 */
60 }
61 
62 void serial8250_uart_flush_tx_fifo(vaddr_t base)
63 {
64 	while (1) {
65 		uint8_t state = read8(base + UART_LSR);
66 
67 		/* waiting transmit fifo empty */
68 		if ((state & LSR_EMPTY) == LSR_EMPTY)
69 			break;
70 	}
71 }
72 
73 bool serial8250_uart_have_rx_data(vaddr_t base)
74 {
75 	return (read32(base + UART_LSR) & LSR_DR);
76 }
77 
78 void serial8250_uart_putc(int ch, vaddr_t base)
79 {
80 	serial8250_uart_flush_tx_fifo(base);
81 
82 	/* write out charset to transmit fifo */
83 	write8(ch, base + UART_THR);
84 }
85 
86 int serial8250_uart_getchar(vaddr_t base)
87 {
88 	while (!serial8250_uart_have_rx_data(base)) {
89 		/* transmit fifo is empty, waiting again. */
90 		;
91 	}
92 	return read8(base + UART_RHR);
93 }
94 
95