Sync usage with man page.
[netbsd-mini2440.git] / sys / arch / mips / sibyte / dev / sbscnvar.h
blobdb79bfe711107f2d0e6e16e0d2a23e80033d97bb
1 /* $NetBSD: sbscnvar.h,v 1.2 2003/02/07 17:38:49 cgd Exp $ */
3 /*
4 * Copyright 2000, 2001
5 * Broadcom Corporation. All rights reserved.
7 * This software is furnished under license and may be used and copied only
8 * in accordance with the following terms and conditions. Subject to these
9 * conditions, you may download, copy, install, use, modify and distribute
10 * modified or unmodified copies of this software in source and/or binary
11 * form. No title or ownership is transferred hereby.
13 * 1) Any source code used, modified or distributed must reproduce and
14 * retain this copyright notice and list of conditions as they appear in
15 * the source file.
17 * 2) No right is granted to use any trade name, trademark, or logo of
18 * Broadcom Corporation. The "Broadcom Corporation" name may not be
19 * used to endorse or promote products derived from this software
20 * without the prior written permission of Broadcom Corporation.
22 * 3) THIS SOFTWARE IS PROVIDED "AS-IS" AND ANY EXPRESS OR IMPLIED
23 * WARRANTIES, INCLUDING BUT NOT LIMITED TO, ANY IMPLIED WARRANTIES OF
24 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR
25 * NON-INFRINGEMENT ARE DISCLAIMED. IN NO EVENT SHALL BROADCOM BE LIABLE
26 * FOR ANY DAMAGES WHATSOEVER, AND IN PARTICULAR, BROADCOM SHALL NOT BE
27 * LIABLE FOR DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
29 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
30 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
31 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
32 * OR OTHERWISE), EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 /* from: $NetBSD: comvar.h,v 1.32 2000/03/23 07:01:30 thorpej Exp */
38 * Copyright (c) 1996 Christopher G. Demetriou. All rights reserved.
40 * Redistribution and use in source and binary forms, with or without
41 * modification, are permitted provided that the following conditions
42 * are met:
43 * 1. Redistributions of source code must retain the above copyright
44 * notice, this list of conditions and the following disclaimer.
45 * 2. Redistributions in binary form must reproduce the above copyright
46 * notice, this list of conditions and the following disclaimer in the
47 * documentation and/or other materials provided with the distribution.
48 * 3. All advertising materials mentioning features or use of this software
49 * must display the following acknowledgement:
50 * This product includes software developed by Christopher G. Demetriou
51 * for the NetBSD Project.
52 * 4. The name of the author may not be used to endorse or promote products
53 * derived from this software without specific prior written permission
55 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
56 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
57 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
58 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
59 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
60 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
61 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
62 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
63 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
64 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
67 #include "rnd.h"
68 #if NRND > 0 && defined(RND_SBSCN)
69 #include <sys/rnd.h>
70 #endif
72 #include <sys/callout.h>
74 #define SBSCN_CHAN(x) ((minor(x) & 0x00001) >> 0)
75 #define SBSCN_UNIT(x) ((minor(x) & 0x7fffe) >> 1)
76 #define SBSCN_DIALOUT(x) ((minor(x) & 0x80000) != 0)
78 #define SBSCN_TOLERANCE 30 /* baud rate tolerance, in 0.1% units */
80 int sbscn_cnattach(u_long addr, int chan, int rate,
81 tcflag_t cflag);
82 #ifdef KGDB
83 int sbscn_kgdb_attach(u_long addr, int chan, int rate,
84 tcflag_t cflag);
85 #endif
86 int sbscn_is_console(u_long addr, int chan);
88 /* Hardware flag masks */
89 #define SBSCN_HW_CONSOLE 0x01
90 #define SBSCN_HW_KGDB 0x02
91 #define SBSCN_HW_DEV_OK 0x04
93 /* Buffer size for character buffer */
94 #define SBSCN_RING_SIZE 2048
96 struct sbscn_channel {
97 int ch_num;
98 struct sbscn_softc *ch_sc;
99 struct tty *ch_tty; /* tty struct */
100 void *ch_intrhand; /* interrupt registration handle */
101 void *ch_si; /* softintr cookie */
102 struct callout ch_diag_callout; /* callout for diagnostic msgs */
104 volatile char *ch_base; /* kseg1 addr of channel regs */
105 volatile char *ch_isr_base; /* kseg1 addr of channel ISR */
106 volatile char *ch_imr_base; /* kseg1 addr of channel IMR */
107 #ifdef XXXCGDnotyet
108 volatile char *ch_inchg_base; /* kseg1 addr of channel inport-chg */
109 #endif
111 u_int ch_overflows;
112 u_int ch_floods;
113 u_int ch_errors;
115 u_int ch_hwflags;
116 u_int ch_swflags;
118 u_int ch_r_hiwat;
119 u_int ch_r_lowat;
121 /* receive ring buffer management */
122 u_char *volatile ch_rbget;
123 u_char *volatile ch_rbput;
124 volatile u_int ch_rbavail;
125 u_char *ch_rbuf;
126 u_char *ch_ebuf;
128 /* transmit buffer management */
129 u_char *ch_tba;
130 u_int ch_tbc;
131 u_int ch_heldtbc;
133 volatile u_int ch_rx_flags;
134 #define RX_TTY_BLOCKED 0x01
135 #define RX_TTY_OVERFLOWED 0x02
136 #define RX_IBUF_BLOCKED 0x04
137 #define RX_IBUF_OVERFLOWED 0x08
138 #define RX_ANY_BLOCK 0x0f
139 volatile u_int ch_tx_busy;
140 volatile u_int ch_tx_done;
141 volatile u_int ch_tx_stopped;
142 volatile u_int ch_st_check;
143 volatile u_int ch_rx_ready;
145 volatile u_char ch_heldchange;
147 volatile u_int ch_brc;
148 volatile u_char ch_imr;
149 volatile u_char ch_iports, ch_iports_delta;
150 volatile u_char ch_oports, ch_oports_active;
151 volatile u_char ch_mode1, ch_mode2;
153 u_char ch_i_dcd, ch_i_cts, ch_i_dsr, ch_i_ri, ch_i_mask;
154 u_char ch_o_dtr, ch_o_rts, ch_o_mask;
156 u_char ch_i_dcd_pin, ch_i_cts_pin, ch_i_dsr_pin, ch_i_ri_pin;
157 u_char ch_o_dtr_pin, ch_o_rts_pin;
159 #if NRND > 0 && defined(RND_SBSCN)
160 rndsource_element_t ch_rnd_source;
161 #endif
164 struct sbscn_softc {
165 struct device sc_dev; /* base device */
167 /* shared data structures */
168 u_long sc_addr; /* phys addr of DUART XXX bus_space */
170 struct sbscn_channel sc_channels[2];