comvar.h revision 1.89 1 /* $NetBSD: comvar.h,v 1.89 2018/12/08 17:46:13 thorpej Exp $ */
2
3 /*
4 * Copyright (c) 1996 Christopher G. Demetriou. 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
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * 3. All advertising materials mentioning features or use of this software
15 * must display the following acknowledgement:
16 * This product includes software developed by Christopher G. Demetriou
17 * for the NetBSD Project.
18 * 4. The name of the author may not be used to endorse or promote products
19 * derived from this software without specific prior written permission
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
22 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
23 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
24 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
25 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
26 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
30 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 */
32
33 #include "opt_multiprocessor.h"
34 #include "opt_lockdebug.h"
35 #include "opt_com.h"
36 #include "opt_kgdb.h"
37
38 #ifdef RND_COM
39 #include <sys/rndsource.h>
40 #endif
41
42 #include <sys/callout.h>
43 #include <sys/timepps.h>
44 #include <sys/mutex.h>
45 #include <sys/device.h>
46
47 #include <dev/ic/comreg.h> /* for COM_NPORTS */
48
49 struct com_regs;
50
51 int comcnattach(bus_space_tag_t, bus_addr_t, int, int, int, tcflag_t);
52 int comcnattach1(struct com_regs *, int, int, int, tcflag_t);
53
54 #ifdef KGDB
55 int com_kgdb_attach(bus_space_tag_t, bus_addr_t, int, int, int, tcflag_t);
56 int com_kgdb_attach1(struct com_regs *, int, int, int, tcflag_t);
57 #endif
58
59 int com_is_console(bus_space_tag_t, bus_addr_t, bus_space_handle_t *);
60
61 /* Hardware flag masks */
62 #define COM_HW_NOIEN 0x01
63 #define COM_HW_FIFO 0x02
64 /* 0x04 free for use */
65 #define COM_HW_FLOW 0x08
66 #define COM_HW_DEV_OK 0x20
67 #define COM_HW_CONSOLE 0x40
68 #define COM_HW_KGDB 0x80
69 #define COM_HW_TXFIFO_DISABLE 0x100
70 #define COM_HW_NO_TXPRELOAD 0x200
71 #define COM_HW_AFE 0x400
72 #define COM_HW_POLL 0x800
73
74 /* Buffer size for character buffer */
75 #ifndef COM_RING_SIZE
76 #define COM_RING_SIZE 2048
77 #endif
78
79 #ifdef COM_REGMAP
80 #define COM_REG_RXDATA 0
81 #define COM_REG_TXDATA 1
82 #define COM_REG_DLBL 2
83 #define COM_REG_DLBH 3
84 #define COM_REG_IER 4
85 #define COM_REG_IIR 5
86 #define COM_REG_FIFO 6
87 #define COM_REG_TCR 6
88 #define COM_REG_EFR 7
89 #define COM_REG_TLR 7
90 #define COM_REG_LCR 8
91 #define COM_REG_MDR1 8
92 #define COM_REG_MCR 9
93 #define COM_REG_LSR 10
94 #define COM_REG_MSR 11
95 #define COM_REG_USR 31 /* 16750/DW APB */
96 #define COM_REG_TFL com_tfl /* DW APB */
97 #define COM_REG_RFL com_rfl /* DW APB */
98 #define COM_REG_HALT com_halt /* DW APB */
99
100 struct com_regs {
101 bus_space_tag_t cr_iot;
102 bus_space_handle_t cr_ioh;
103 bus_addr_t cr_iobase;
104 bus_size_t cr_nports;
105 bus_size_t cr_map[42];
106 };
107 #else /* ! COM_REGMAP */
108 #define COM_REG_RXDATA com_data
109 #define COM_REG_TXDATA com_data
110 #define COM_REG_DLBL com_dlbl
111 #define COM_REG_DLBH com_dlbh
112 #define COM_REG_IER com_ier
113 #define COM_REG_IIR com_iir
114 #define COM_REG_FIFO com_fifo
115 #define COM_REG_EFR com_efr
116 #define COM_REG_LCR com_lctl
117 #define COM_REG_MCR com_mcr
118 #define COM_REG_LSR com_lsr
119 #define COM_REG_MSR com_msr
120 #define COM_REG_TCR com_msr
121 #define COM_REG_TLR com_scratch
122 #define COM_REG_MDR1 8
123 #define COM_REG_USR com_usr /* 16750/DW APB */
124 #define COM_REG_TFL com_tfl /* DW APB */
125 #define COM_REG_RFL com_rfl /* DW APB */
126 #define COM_REG_HALT com_halt /* DW APB */
127
128 struct com_regs {
129 bus_space_tag_t cr_iot;
130 bus_space_handle_t cr_ioh;
131 bus_addr_t cr_iobase;
132 bus_size_t cr_nports;
133 };
134
135 #endif /* COM_REGMAP */
136
137 void com_init_regs(struct com_regs *, bus_space_tag_t, bus_space_handle_t,
138 bus_addr_t);
139
140 struct comcons_info {
141 struct com_regs regs;
142 int rate;
143 int frequency;
144 int type;
145 tcflag_t cflag;
146 };
147
148 struct com_softc {
149 device_t sc_dev;
150 void *sc_si;
151 struct tty *sc_tty;
152
153 callout_t sc_diag_callout;
154 callout_t sc_poll_callout;
155
156 int sc_frequency;
157
158 struct com_regs sc_regs;
159 bus_space_handle_t sc_hayespioh;
160
161
162 u_int sc_overflows,
163 sc_floods,
164 sc_errors;
165
166 int sc_hwflags,
167 sc_swflags;
168 u_int sc_fifolen;
169
170 u_int sc_r_hiwat,
171 sc_r_lowat;
172 u_char *volatile sc_rbget,
173 *volatile sc_rbput;
174 volatile u_int sc_rbavail;
175 u_char *sc_rbuf,
176 *sc_ebuf;
177
178 u_char *sc_tba;
179 u_int sc_tbc,
180 sc_heldtbc;
181
182 volatile u_char sc_rx_flags,
183 #define RX_TTY_BLOCKED 0x01
184 #define RX_TTY_OVERFLOWED 0x02
185 #define RX_IBUF_BLOCKED 0x04
186 #define RX_IBUF_OVERFLOWED 0x08
187 #define RX_ANY_BLOCK 0x0f
188 sc_tx_busy,
189 sc_tx_done,
190 sc_tx_stopped,
191 sc_st_check,
192 sc_rx_ready;
193
194 volatile u_char sc_heldchange;
195 volatile u_char sc_msr, sc_msr_delta, sc_msr_mask, sc_mcr,
196 sc_mcr_active, sc_lcr, sc_ier, sc_fifo, sc_dlbl, sc_dlbh, sc_efr;
197 u_char sc_mcr_dtr, sc_mcr_rts, sc_msr_cts, sc_msr_dcd;
198
199 u_char sc_prescaler; /* for COM_TYPE_HAYESP */
200
201 /*
202 * There are a great many almost-ns16550-compatible UARTs out
203 * there, which have minor differences. The type field here
204 * lets us distinguish between them.
205 */
206 int sc_type;
207 #define COM_TYPE_NORMAL 0 /* normal 16x50 */
208 #define COM_TYPE_HAYESP 1 /* Hayes ESP modem */
209 #define COM_TYPE_PXA2x0 2 /* Intel PXA2x0 processor built-in */
210 #define COM_TYPE_AU1x00 3 /* AMD/Alchemy Au1x000 proc. built-in */
211 #define COM_TYPE_OMAP 4 /* TI OMAP processor built-in */
212 #define COM_TYPE_16550_NOERS 5 /* like a 16550, no ERS */
213 #define COM_TYPE_INGENIC 6 /* JZ4780 built-in */
214 #define COM_TYPE_TEGRA 7 /* NVIDIA Tegra built-in */
215 #define COM_TYPE_BCMAUXUART 8 /* BCM2835 AUX UART */
216 #define COM_TYPE_16650 9
217 #define COM_TYPE_16750 10
218 #define COM_TYPE_DW_APB 11 /* DesignWare APB UART */
219
220 /* power management hooks */
221 int (*enable)(struct com_softc *);
222 void (*disable)(struct com_softc *);
223 int enabled;
224
225 /* XXXX: vendor workaround functions */
226 int (*sc_vendor_workaround)(struct com_softc *);
227
228 struct pps_state sc_pps_state; /* pps state */
229
230 #ifdef RND_COM
231 krndsource_t rnd_source;
232 #endif
233 kmutex_t sc_lock;
234 };
235
236 int comprobe1(bus_space_tag_t, bus_space_handle_t);
237 int comintr(void *);
238 void com_attach_subr(struct com_softc *);
239 int com_probe_subr(struct com_regs *);
240 int com_detach(device_t, int);
241 bool com_resume(device_t, const pmf_qual_t *);
242 bool com_cleanup(device_t, int);
243 bool com_suspend(device_t, const pmf_qual_t *);
244
245 #ifndef IPL_SERIAL
246 #define IPL_SERIAL IPL_TTY
247 #define splserial() spltty()
248 #endif
249