1 /*-
2 * SPDX-License-Identifier: BSD-2-Clause
3 *
4 * Copyright (c) 2003 Marcel Moolenaar
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
9 * are met:
10 *
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29 #ifndef _DEV_UART_H_
30 #define _DEV_UART_H_
31
32 #include <sys/linker_set.h>
33
34 /*
35 * Bus access structure. This structure holds the minimum information needed
36 * to access the UART. The rclk field, although not important to actually
37 * access the UART, is important for baudrate programming, delay loops and
38 * other timing related computations.
39 */
40 struct uart_bas {
41 bus_space_tag_t bst;
42 bus_space_handle_t bsh;
43 u_int chan;
44 u_int rclk;
45 u_int regshft;
46 u_int regiowidth;
47 u_int busy_detect;
48 };
49
50 #define uart_regofs(bas, reg) ((reg) << (bas)->regshft)
51 #define uart_regiowidth(bas) ((bas)->regiowidth)
52
53 static inline uint32_t
uart_getreg(struct uart_bas * bas,int reg)54 uart_getreg(struct uart_bas *bas, int reg)
55 {
56 uint32_t ret;
57
58 switch (uart_regiowidth(bas)) {
59 #if !defined(__i386__)
60 case 8:
61 ret = bus_space_read_8(bas->bst, bas->bsh, uart_regofs(bas, reg));
62 break;
63 #endif
64 case 4:
65 ret = bus_space_read_4(bas->bst, bas->bsh, uart_regofs(bas, reg));
66 break;
67 case 2:
68 ret = bus_space_read_2(bas->bst, bas->bsh, uart_regofs(bas, reg));
69 break;
70 default:
71 ret = bus_space_read_1(bas->bst, bas->bsh, uart_regofs(bas, reg));
72 break;
73 }
74
75 return (ret);
76 }
77
78 static inline void
uart_setreg(struct uart_bas * bas,int reg,uint32_t value)79 uart_setreg(struct uart_bas *bas, int reg, uint32_t value)
80 {
81
82 switch (uart_regiowidth(bas)) {
83 #if !defined(__i386__)
84 case 8:
85 bus_space_write_8(bas->bst, bas->bsh, uart_regofs(bas, reg), value);
86 break;
87 #endif
88 case 4:
89 bus_space_write_4(bas->bst, bas->bsh, uart_regofs(bas, reg), value);
90 break;
91 case 2:
92 bus_space_write_2(bas->bst, bas->bsh, uart_regofs(bas, reg), value);
93 break;
94 default:
95 bus_space_write_1(bas->bst, bas->bsh, uart_regofs(bas, reg), value);
96 break;
97 }
98 }
99
100 /*
101 * XXX we don't know the length of the bus space address range in use by
102 * the UART. Since barriers don't use the length field currently, we put
103 * a zero there for now.
104 */
105 #define uart_barrier(bas) \
106 bus_space_barrier((bas)->bst, (bas)->bsh, 0, 0, \
107 BUS_SPACE_BARRIER_READ|BUS_SPACE_BARRIER_WRITE)
108
109 /*
110 * UART device classes.
111 */
112 struct uart_class;
113
114 SET_DECLARE(uart_class_set, struct uart_class);
115
116 extern struct uart_class uart_ns8250_class __attribute__((weak));
117 extern struct uart_class uart_quicc_class __attribute__((weak));
118 extern struct uart_class uart_z8530_class __attribute__((weak));
119
120 /*
121 * Device flags.
122 */
123 #define UART_FLAGS_CONSOLE(f) ((f) & 0x10)
124 #define UART_FLAGS_DBGPORT(f) ((f) & 0x80)
125 #define UART_FLAGS_FCR_RX_LOW(f) ((f) & 0x100)
126 #define UART_FLAGS_FCR_RX_MEDL(f) ((f) & 0x200)
127 #define UART_FLAGS_FCR_RX_MEDH(f) ((f) & 0x400)
128 #define UART_FLAGS_FCR_RX_HIGH(f) ((f) & 0x800)
129
130 /*
131 * Data parity values (magical numbers related to ns8250).
132 */
133 #define UART_PARITY_NONE 0
134 #define UART_PARITY_ODD 1
135 #define UART_PARITY_EVEN 3
136 #define UART_PARITY_MARK 5
137 #define UART_PARITY_SPACE 7
138
139 #endif /* _DEV_UART_H_ */
140