xref: /optee_os/core/include/drivers/ns16550.h (revision fbe66cf83199aa6a2aca9f93384cf1ad9185a5f6)
1 /* SPDX-License-Identifier: BSD-2-Clause */
2 /*
3  * Copyright (C) 2015 Freescale Semiconductor, Inc.
4  * Copyright (c) 2020, Linaro Limited
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions are met:
9  *
10  * 1. Redistributions of source code must retain the above copyright notice,
11  * this list of conditions and the following disclaimer.
12  *
13  * 2. Redistributions in binary form must reproduce the above copyright notice,
14  * this list of conditions and the following disclaimer in the documentation
15  * and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
21  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27  * POSSIBILITY OF SUCH DAMAGE.
28  */
29 #ifndef __DRIVERS_NS16550_H
30 #define __DRIVERS_NS16550_H
31 
32 #include <drivers/serial.h>
33 #include <io.h>
34 #include <types_ext.h>
35 
36 #define NS16550_UART_REG_SIZE	0x1000
37 
38 #define IO_WIDTH_U8		0
39 #define IO_WIDTH_U32		1
40 
41 struct ns16550_data {
42 	struct io_pa_va base;
43 	struct serial_chip chip;
44 	uint8_t io_width;
45 	uint8_t reg_shift;
46 };
47 
serial_in(vaddr_t addr,uint8_t io_width)48 static inline unsigned int serial_in(vaddr_t addr, uint8_t io_width)
49 {
50 	if (io_width == IO_WIDTH_U32)
51 		return io_read32(addr);
52 	else
53 		return io_read8(addr);
54 }
55 
serial_out(vaddr_t addr,uint8_t io_width,int ch)56 static inline void serial_out(vaddr_t addr, uint8_t io_width, int ch)
57 {
58 	if (io_width == IO_WIDTH_U32)
59 		io_write32(addr, ch);
60 	else
61 		io_write8(addr, ch);
62 }
63 
64 void ns16550_init(struct ns16550_data *pd, paddr_t base, uint8_t io_width,
65 		  uint8_t reg_shift);
66 
67 #endif /* __DRIVERS_NS16550_H */
68