rtl81x9var.h revision 1.29 1 /* $NetBSD: rtl81x9var.h,v 1.29 2006/11/03 14:41:41 tsutsui Exp $ */
2
3 /*
4 * Copyright (c) 1997, 1998
5 * Bill Paul <wpaul (at) ctr.columbia.edu>. 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 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. All advertising materials mentioning features or use of this software
16 * must display the following acknowledgement:
17 * This product includes software developed by Bill Paul.
18 * 4. Neither the name of the author nor the names of any co-contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
21 *
22 * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
26 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
27 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
28 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
30 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
31 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
32 * THE POSSIBILITY OF SUCH DAMAGE.
33 *
34 * FreeBSD Id: if_rlreg.h,v 1.9 1999/06/20 18:56:09 wpaul Exp
35 */
36
37 #include "rnd.h"
38
39 #if NRND > 0
40 #include <sys/rnd.h>
41 #endif
42
43 #ifdef __NO_STRICT_ALIGNMENT
44 #define RTK_ETHER_ALIGN 0
45 #else
46 #define RTK_ETHER_ALIGN 2
47 #endif
48 #define RTK_RXSTAT_LEN 4
49
50 struct rtk_type {
51 uint16_t rtk_vid;
52 uint16_t rtk_did;
53 int rtk_basetype;
54 const char *rtk_name;
55 };
56
57 struct rtk_hwrev {
58 uint32_t rtk_rev;
59 int rtk_type;
60 const char *rtk_desc;
61 };
62
63 struct rtk_mii_frame {
64 uint8_t mii_stdelim;
65 uint8_t mii_opcode;
66 uint8_t mii_phyaddr;
67 uint8_t mii_regaddr;
68 uint8_t mii_turnaround;
69 uint16_t mii_data;
70 };
71
72 /*
73 * MII constants
74 */
75 #define RTK_MII_STARTDELIM 0x01
76 #define RTK_MII_READOP 0x02
77 #define RTK_MII_WRITEOP 0x01
78 #define RTK_MII_TURNAROUND 0x02
79
80 #define RTK_8129 1
81 #define RTK_8139 2
82 #define RTK_8139CPLUS 3
83 #define RTK_8169 4
84
85 #define RTK_ISCPLUS(x) ((x)->rtk_type == RTK_8139CPLUS || \
86 (x)->rtk_type == RTK_8169)
87
88 #define RTK_TX_QLEN 64
89
90 /*
91 * The 8139C+ and 8160 gigE chips support descriptor-based TX
92 * and RX. In fact, they even support TCP large send. Descriptors
93 * must be allocated in contiguous blocks that are aligned on a
94 * 256-byte boundary. The rings can hold a maximum of 64 descriptors.
95 */
96
97 struct rtk_rxsoft {
98 struct mbuf *rxs_mbuf;
99 bus_dmamap_t rxs_dmamap;
100 };
101
102 struct rtk_list_data {
103 struct rtk_txq {
104 struct mbuf *txq_mbuf;
105 bus_dmamap_t txq_dmamap;
106 int txq_descidx;
107 } rtk_txq[RTK_TX_QLEN];
108 int rtk_txq_considx;
109 int rtk_txq_prodidx;
110 bus_dmamap_t rtk_tx_list_map;
111 struct rtk_desc *rtk_tx_list;
112 bus_dma_segment_t rtk_tx_listseg;
113 int rtk_tx_free; /* # of free descriptors */
114 int rtk_tx_nextfree; /* next descriptor to use */
115 int rtk_tx_desc_cnt; /* # of descriptors */
116 int rtk_tx_listnseg;
117
118 struct rtk_rxsoft rtk_rxsoft[RTK_RX_DESC_CNT];
119 bus_dmamap_t rtk_rx_list_map;
120 struct rtk_desc *rtk_rx_list;
121 bus_dma_segment_t rtk_rx_listseg;
122 int rtk_rx_prodidx;
123 int rtk_rx_listnseg;
124 };
125 struct rtk_tx_desc {
126 SIMPLEQ_ENTRY(rtk_tx_desc) txd_q;
127 struct mbuf *txd_mbuf;
128 bus_dmamap_t txd_dmamap;
129 bus_addr_t txd_txaddr;
130 bus_addr_t txd_txstat;
131 };
132
133 struct rtk_softc {
134 struct device sc_dev; /* generic device structures */
135 struct ethercom ethercom; /* interface info */
136 struct mii_data mii;
137 struct callout rtk_tick_ch; /* tick callout */
138 bus_space_handle_t rtk_bhandle; /* bus space handle */
139 bus_space_tag_t rtk_btag; /* bus space tag */
140 int rtk_type;
141 bus_dma_tag_t sc_dmat;
142 bus_dma_segment_t sc_dmaseg;
143 int sc_dmanseg;
144
145 bus_dmamap_t recv_dmamap;
146 caddr_t rtk_rx_buf;
147
148 struct rtk_tx_desc rtk_tx_descs[RTK_TX_LIST_CNT];
149 SIMPLEQ_HEAD(, rtk_tx_desc) rtk_tx_free;
150 SIMPLEQ_HEAD(, rtk_tx_desc) rtk_tx_dirty;
151 struct rtk_list_data rtk_ldata;
152 struct mbuf *rtk_head;
153 struct mbuf *rtk_tail;
154 uint32_t rtk_rxlenmask;
155 int rtk_testmode;
156
157 int sc_flags; /* misc flags */
158 int sc_txthresh; /* Early tx threshold */
159 int sc_rev; /* revision within rtk_type */
160
161 void *sc_sdhook; /* shutdown hook */
162 void *sc_powerhook; /* power management hook */
163
164 /* Power management hooks. */
165 int (*sc_enable) (struct rtk_softc *);
166 void (*sc_disable) (struct rtk_softc *);
167 void (*sc_power) (struct rtk_softc *, int);
168 #if NRND > 0
169 rndsource_element_t rnd_source;
170 #endif
171 };
172
173 #define RTK_TX_DESC_CNT(sc) \
174 ((sc)->rtk_ldata.rtk_tx_desc_cnt)
175 #define RTK_TX_LIST_SZ(sc) \
176 (RTK_TX_DESC_CNT(sc) * sizeof(struct rtk_desc))
177 #define RTK_NEXT_TX_DESC(sc, x) \
178 (((x) + 1) % RTK_TX_DESC_CNT(sc))
179 #define RTK_NEXT_RX_DESC(sc, x) \
180 (((x) + 1) % RTK_RX_DESC_CNT)
181 #define RTK_NEXT_TXQ(sc, x) \
182 (((x) + 1) % RTK_TX_QLEN)
183
184 #define RTK_TXDESCSYNC(sc, idx, ops) \
185 bus_dmamap_sync((sc)->sc_dmat, \
186 (sc)->rtk_ldata.rtk_tx_list_map, \
187 sizeof(struct rtk_desc) * (idx), \
188 sizeof(struct rtk_desc), \
189 (ops))
190 #define RTK_RXDESCSYNC(sc, idx, ops) \
191 bus_dmamap_sync((sc)->sc_dmat, \
192 (sc)->rtk_ldata.rtk_rx_list_map, \
193 sizeof(struct rtk_desc) * (idx), \
194 sizeof(struct rtk_desc), \
195 (ops))
196
197 #define RTK_ATTACHED 0x00000001 /* attach has succeeded */
198 #define RTK_ENABLED 0x00000002 /* chip is enabled */
199
200 #define RTK_IS_ENABLED(sc) ((sc)->sc_flags & RTK_ENABLED)
201 #define RTK_TX_THRESH(sc) (((sc)->sc_txthresh << 16) & 0x003F0000)
202
203 #define TXTH_256 8
204 #define TXTH_MAX 48
205
206 /*
207 * register space access macros
208 */
209 #define CSR_WRITE_4(sc, reg, val) \
210 bus_space_write_4(sc->rtk_btag, sc->rtk_bhandle, reg, val)
211 #define CSR_WRITE_2(sc, reg, val) \
212 bus_space_write_2(sc->rtk_btag, sc->rtk_bhandle, reg, val)
213 #define CSR_WRITE_1(sc, reg, val) \
214 bus_space_write_1(sc->rtk_btag, sc->rtk_bhandle, reg, val)
215
216 #define CSR_READ_4(sc, reg) \
217 bus_space_read_4(sc->rtk_btag, sc->rtk_bhandle, reg)
218 #define CSR_READ_2(sc, reg) \
219 bus_space_read_2(sc->rtk_btag, sc->rtk_bhandle, reg)
220 #define CSR_READ_1(sc, reg) \
221 bus_space_read_1(sc->rtk_btag, sc->rtk_bhandle, reg)
222
223 #define RTK_TIMEOUT 1000
224
225 /*
226 * PCI low memory base and low I/O base registers
227 */
228
229 #define RTK_PCI_LOIO 0x10
230 #define RTK_PCI_LOMEM 0x14
231
232 #ifdef _KERNEL
233 uint16_t rtk_read_eeprom(struct rtk_softc *, int, int);
234 void rtk_setmulti(struct rtk_softc *);
235 void rtk_attach(struct rtk_softc *);
236 int rtk_detach(struct rtk_softc *);
237 int rtk_activate(struct device *, enum devact);
238 int rtk_intr(void *);
239 #endif /* _KERNEL */
240