1 /* $NetBSD: comvar.h,v 1.66 2009/05/27 23:01:07 rjs 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 "rnd.h" 34 #include "opt_multiprocessor.h" 35 #include "opt_lockdebug.h" 36 #include "opt_com.h" 37 #include "opt_kgdb.h" 38 39 #if NRND > 0 && defined(RND_COM) 40 #include <sys/rnd.h> 41 #endif 42 43 #include <sys/callout.h> 44 #include <sys/timepps.h> 45 #include <sys/mutex.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 72 /* Buffer size for character buffer */ 73 #ifndef COM_RING_SIZE 74 #define COM_RING_SIZE 2048 75 #endif 76 77 #ifdef COM_REGMAP 78 #define COM_REG_RXDATA 0 79 #define COM_REG_TXDATA 1 80 #define COM_REG_DLBL 2 81 #define COM_REG_DLBH 3 82 #define COM_REG_IER 4 83 #define COM_REG_IIR 5 84 #define COM_REG_FIFO 6 85 #define COM_REG_TCR 6 86 #define COM_REG_EFR 7 87 #define COM_REG_TLR 7 88 #define COM_REG_LCR 8 89 #define COM_REG_MDR1 8 90 #define COM_REG_MCR 9 91 #define COM_REG_LSR 10 92 #define COM_REG_MSR 11 93 94 struct com_regs { 95 bus_space_tag_t cr_iot; 96 bus_space_handle_t cr_ioh; 97 bus_addr_t cr_iobase; 98 bus_size_t cr_nports; 99 bus_size_t cr_map[16]; 100 }; 101 102 extern const bus_size_t com_std_map[16]; 103 104 #define COM_INIT_REGS(regs, tag, hdl, addr) \ 105 do { \ 106 regs.cr_iot = tag; \ 107 regs.cr_ioh = hdl; \ 108 regs.cr_iobase = addr; \ 109 regs.cr_nports = COM_NPORTS; \ 110 memcpy(regs.cr_map, com_std_map, sizeof (regs.cr_map)); \ 111 } while (0) 112 113 #else 114 #define COM_REG_RXDATA com_data 115 #define COM_REG_TXDATA com_data 116 #define COM_REG_DLBL com_dlbl 117 #define COM_REG_DLBH com_dlbh 118 #define COM_REG_IER com_ier 119 #define COM_REG_IIR com_iir 120 #define COM_REG_FIFO com_fifo 121 #define COM_REG_EFR com_efr 122 #define COM_REG_LCR com_lctl 123 #define COM_REG_MCR com_mcr 124 #define COM_REG_LSR com_lsr 125 #define COM_REG_MSR com_msr 126 #define COM_REG_TCR com_msr 127 #define COM_REG_TLR com_scratch 128 #define COM_REG_MDR1 8 129 130 struct com_regs { 131 bus_space_tag_t cr_iot; 132 bus_space_handle_t cr_ioh; 133 bus_addr_t cr_iobase; 134 bus_size_t cr_nports; 135 }; 136 137 #define COM_INIT_REGS(regs, tag, hdl, addr) \ 138 do { \ 139 regs.cr_iot = tag; \ 140 regs.cr_ioh = hdl; \ 141 regs.cr_iobase = addr; \ 142 regs.cr_nports = COM_NPORTS; \ 143 } while (0) 144 145 #endif 146 147 struct com_softc { 148 device_t sc_dev; 149 void *sc_si; 150 struct tty *sc_tty; 151 152 struct callout sc_diag_callout; 153 154 int sc_frequency; 155 156 struct com_regs sc_regs; 157 bus_space_handle_t sc_hayespioh; 158 159 160 u_int sc_overflows, 161 sc_floods, 162 sc_errors; 163 164 int sc_hwflags, 165 sc_swflags; 166 u_int sc_fifolen; 167 168 u_int sc_r_hiwat, 169 sc_r_lowat; 170 u_char *volatile sc_rbget, 171 *volatile sc_rbput; 172 volatile u_int sc_rbavail; 173 u_char *sc_rbuf, 174 *sc_ebuf; 175 176 u_char *sc_tba; 177 u_int sc_tbc, 178 sc_heldtbc; 179 180 volatile u_char sc_rx_flags, 181 #define RX_TTY_BLOCKED 0x01 182 #define RX_TTY_OVERFLOWED 0x02 183 #define RX_IBUF_BLOCKED 0x04 184 #define RX_IBUF_OVERFLOWED 0x08 185 #define RX_ANY_BLOCK 0x0f 186 sc_tx_busy, 187 sc_tx_done, 188 sc_tx_stopped, 189 sc_st_check, 190 sc_rx_ready; 191 192 volatile u_char sc_heldchange; 193 volatile u_char sc_msr, sc_msr_delta, sc_msr_mask, sc_mcr, 194 sc_mcr_active, sc_lcr, sc_ier, sc_fifo, sc_dlbl, sc_dlbh, sc_efr; 195 u_char sc_mcr_dtr, sc_mcr_rts, sc_msr_cts, sc_msr_dcd; 196 197 #ifdef COM_HAYESP 198 u_char sc_prescaler; 199 #endif 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 214 /* power management hooks */ 215 int (*enable)(struct com_softc *); 216 void (*disable)(struct com_softc *); 217 int enabled; 218 219 struct pps_state sc_pps_state; /* pps state */ 220 221 #if NRND > 0 && defined(RND_COM) 222 rndsource_element_t rnd_source; 223 #endif 224 kmutex_t sc_lock; 225 }; 226 227 int comprobe1(bus_space_tag_t, bus_space_handle_t); 228 int comintr(void *); 229 void com_attach_subr(struct com_softc *); 230 int com_probe_subr(struct com_regs *); 231 int com_detach(device_t, int); 232 bool com_resume(device_t PMF_FN_PROTO); 233 int com_activate(device_t, enum devact); 234 bool com_cleanup(device_t, int); 235 bool com_suspend(device_t PMF_FN_PROTO); 236 237 #ifndef IPL_SERIAL 238 #define IPL_SERIAL IPL_TTY 239 #define splserial() spltty() 240 #endif 241