xref: /optee_os/core/drivers/ns16550.c (revision 756aea59d99741416e83f788d9788194c13422d2)
1 /*
2  * Copyright (C) 2015 Freescale Semiconductor, Inc.
3  * Copyright (c) 2017, Linaro Limited
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright notice,
10  * this list of conditions and the following disclaimer.
11  *
12  * 2. Redistributions in binary form must reproduce the above copyright notice,
13  * this list of conditions and the following disclaimer in the documentation
14  * and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
20  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26  * POSSIBILITY OF SUCH DAMAGE.
27  */
28 
29 #include <drivers/ns16550.h>
30 #include <io.h>
31 #include <util.h>
32 
33 /* uart register defines */
34 #define UART_RBR	0x0
35 #define UART_THR	0x0
36 #define UART_IER	0x1
37 #define UART_FCR	0x2
38 #define UART_LCR	0x3
39 #define UART_MCR	0x4
40 #define UART_LSR	0x5
41 #define UART_MSR	0x6
42 #define UART_SPR	0x7
43 
44 /* uart status register bits */
45 #define UART_LSR_THRE	0x20 /* Transmit-hold-register empty */
46 
47 static vaddr_t chip_to_base(struct serial_chip *chip)
48 {
49 	struct ns16550_data *pd =
50 		container_of(chip, struct ns16550_data, chip);
51 
52 	return io_pa_or_va(&pd->base);
53 }
54 
55 static void ns16550_flush(struct serial_chip *chip)
56 {
57 	vaddr_t base = chip_to_base(chip);
58 
59 	while ((read8(base + UART_LSR) & UART_LSR_THRE) == 0)
60 		;
61 }
62 
63 static void ns16550_putc(struct serial_chip *chip, int ch)
64 {
65 	vaddr_t base = chip_to_base(chip);
66 
67 	ns16550_flush(chip);
68 
69 	/* write out charset to Transmit-hold-register */
70 	write8(ch, base + UART_THR);
71 }
72 
73 static const struct serial_ops ns16550_ops = {
74 	.flush = ns16550_flush,
75 	.putc = ns16550_putc,
76 };
77 
78 void ns16550_init(struct ns16550_data *pd, paddr_t base)
79 {
80 	pd->base.pa = base;
81 	pd->chip.ops = &ns16550_ops;
82 
83 	/*
84 	 * Do nothing, uart driver shared with normal world,
85 	 * everything for uart driver initialization is done in bootloader.
86 	 */
87 }
88