WISHBONE B3
[raggedstone] / ethernet / source / ethernet / eth_defines.v
1 //////////////////////////////////////////////////////////////////////
2 //// ////
3 //// eth_defines.v ////
4 //// ////
5 //// This file is part of the Ethernet IP core project ////
6 //// http://www.opencores.org/projects/ethmac/ ////
7 //// ////
8 //// Author(s): ////
9 //// - Igor Mohor (igorM@opencores.org) ////
10 //// ////
11 //// All additional information is available in the Readme.txt ////
12 //// file. ////
13 //// ////
14 //////////////////////////////////////////////////////////////////////
15 //// ////
16 //// Copyright (C) 2001, 2002 Authors ////
17 //// ////
18 //// This source file may be used and distributed without ////
19 //// restriction provided that this copyright statement is not ////
20 //// removed from the file and that any derivative work contains ////
21 //// the original copyright notice and the associated disclaimer. ////
22 //// ////
23 //// This source file is free software; you can redistribute it ////
24 //// and/or modify it under the terms of the GNU Lesser General ////
25 //// Public License as published by the Free Software Foundation; ////
26 //// either version 2.1 of the License, or (at your option) any ////
27 //// later version. ////
28 //// ////
29 //// This source is distributed in the hope that it will be ////
30 //// useful, but WITHOUT ANY WARRANTY; without even the implied ////
31 //// warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR ////
32 //// PURPOSE. See the GNU Lesser General Public License for more ////
33 //// details. ////
34 //// ////
35 //// You should have received a copy of the GNU Lesser General ////
36 //// Public License along with this source; if not, download it ////
37 //// from http://www.opencores.org/lgpl.shtml ////
38 //// ////
39 //////////////////////////////////////////////////////////////////////
40 //
41 // CVS Revision History
42 //
43 // $Log: eth_defines.v,v $
44 // Revision 1.3 2007-03-20 22:39:24 sithglan
45 // WISHBONE B3
46 //
47 // Revision 1.2 2007/03/20 22:17:38 sithglan
48 // += use xilinx block ram for ethernet
49 //
50 // Revision 1.1 2007/03/19 16:44:04 sithglan
51 // lot of new files
52 //
53 // Revision 1.34 2005/02/21 12:48:06 igorm
54 // Warning fixes.
55 //
56 // Revision 1.33 2003/11/12 18:24:58 tadejm
57 // WISHBONE slave changed and tested from only 32-bit accesss to byte access.
58 //
59 // Revision 1.32 2003/10/17 07:46:13 markom
60 // mbist signals updated according to newest convention
61 //
62 // Revision 1.31 2003/08/14 16:42:58 simons
63 // Artisan ram instance added.
64 //
65 // Revision 1.30 2003/06/13 11:55:37 mohor
66 // Define file in eth_cop.v is changed to eth_defines.v. Some defines were
67 // moved from tb_eth_defines.v to eth_defines.v.
68 //
69 // Revision 1.29 2002/11/19 18:13:49 mohor
70 // r_MiiMRst is not used for resetting the MIIM module. wb_rst used instead.
71 //
72 // Revision 1.28 2002/11/15 14:27:15 mohor
73 // Since r_Rst bit is not used any more, default value is changed to 0xa000.
74 //
75 // Revision 1.27 2002/11/01 18:19:34 mohor
76 // Defines fixed to use generic RAM by default.
77 //
78 // Revision 1.26 2002/10/24 18:53:03 mohor
79 // fpga define added.
80 //
81 // Revision 1.3 2002/10/11 16:57:54 igorm
82 // eth_defines.v tagged with rel_5 used.
83 //
84 // Revision 1.25 2002/10/10 16:47:44 mohor
85 // Defines changed to have ETH_ prolog.
86 // ETH_WISHBONE_B# define added.
87 //
88 // Revision 1.24 2002/10/10 16:33:11 mohor
89 // Bist added.
90 //
91 // Revision 1.23 2002/09/23 18:22:48 mohor
92 // Virtual Silicon RAM might be used in the ASIC implementation of the ethernet
93 // core.
94 //
95 // Revision 1.22 2002/09/04 18:36:49 mohor
96 // Defines for control registers added (ETH_TXCTRL and ETH_RXCTRL).
97 //
98 // Revision 1.21 2002/08/16 22:09:47 mohor
99 // Defines for register width added. mii_rst signal in MIIMODER register
100 // changed.
101 //
102 // Revision 1.20 2002/08/14 19:31:48 mohor
103 // Register TX_BD_NUM is changed so it contains value of the Tx buffer descriptors. No
104 // need to multiply or devide any more.
105 //
106 // Revision 1.19 2002/07/23 15:28:31 mohor
107 // Ram , used for BDs changed from generic_spram to eth_spram_256x32.
108 //
109 // Revision 1.18 2002/05/03 10:15:50 mohor
110 // Outputs registered. Reset changed for eth_wishbone module.
111 //
112 // Revision 1.17 2002/04/24 08:52:19 mohor
113 // Compiler directives added. Tx and Rx fifo size incremented. A "late collision"
114 // bug fixed.
115 //
116 // Revision 1.16 2002/03/19 12:53:29 mohor
117 // Some defines that are used in testbench only were moved to tb_eth_defines.v
118 // file.
119 //
120 // Revision 1.15 2002/02/26 16:11:32 mohor
121 // Number of interrupts changed
122 //
123 // Revision 1.14 2002/02/16 14:03:44 mohor
124 // Registered trimmed. Unused registers removed.
125 //
126 // Revision 1.13 2002/02/16 13:06:33 mohor
127 // EXTERNAL_DMA used instead of WISHBONE_DMA.
128 //
129 // Revision 1.12 2002/02/15 10:58:31 mohor
130 // Changed that were lost with last update put back to the file.
131 //
132 // Revision 1.11 2002/02/14 20:19:41 billditt
133 // Modified for Address Checking,
134 // addition of eth_addrcheck.v
135 //
136 // Revision 1.10 2002/02/12 17:01:19 mohor
137 // HASH0 and HASH1 registers added.
138
139 // Revision 1.9 2002/02/08 16:21:54 mohor
140 // Rx status is written back to the BD.
141 //
142 // Revision 1.8 2002/02/05 16:44:38 mohor
143 // Both rx and tx part are finished. Tested with wb_clk_i between 10 and 200
144 // MHz. Statuses, overrun, control frame transmission and reception still need
145 // to be fixed.
146 //
147 // Revision 1.7 2002/01/23 10:28:16 mohor
148 // Link in the header changed.
149 //
150 // Revision 1.6 2001/12/05 15:00:16 mohor
151 // RX_BD_NUM changed to TX_BD_NUM (holds number of TX descriptors
152 // instead of the number of RX descriptors).
153 //
154 // Revision 1.5 2001/12/05 10:21:37 mohor
155 // ETH_RX_BD_ADR register deleted. ETH_RX_BD_NUM is used instead.
156 //
157 // Revision 1.4 2001/11/13 14:23:56 mohor
158 // Generic memory model is used. Defines are changed for the same reason.
159 //
160 // Revision 1.3 2001/10/18 12:07:11 mohor
161 // Status signals changed, Adress decoding changed, interrupt controller
162 // added.
163 //
164 // Revision 1.2 2001/09/24 15:02:56 mohor
165 // Defines changed (All precede with ETH_). Small changes because some
166 // tools generate warnings when two operands are together. Synchronization
167 // between two clocks domains in eth_wishbonedma.v is changed (due to ASIC
168 // demands).
169 //
170 // Revision 1.1 2001/08/06 14:44:29 mohor
171 // A define FPGA added to select between Artisan RAM (for ASIC) and Block Ram (For Virtex).
172 // Include files fixed to contain no path.
173 // File names and module names changed ta have a eth_ prologue in the name.
174 // File eth_timescale.v is used to define timescale
175 // All pin names on the top module are changed to contain _I, _O or _OE at the end.
176 // Bidirectional signal MDIO is changed to three signals (Mdc_O, Mdi_I, Mdo_O
177 // and Mdo_OE. The bidirectional signal must be created on the top level. This
178 // is done due to the ASIC tools.
179 //
180 // Revision 1.1 2001/07/30 21:23:42 mohor
181 // Directory structure changed. Files checked and joind together.
182 //
183 //
184 //
185 //
186 //
187
188
189
190 //`define ETH_BIST // Bist for usage with Virtual Silicon RAMS
191
192 `define ETH_MBIST_CTRL_WIDTH 3 // width of MBIST control bus
193
194 // Ethernet implemented in Xilinx Chips (uncomment following lines)
195 `define ETH_FIFO_XILINX // Use Xilinx distributed ram for tx and rx fifo
196 // `define ETH_XILINX_RAMB4 // Selection of the used memory for Buffer descriptors
197 // Core is going to be implemented in Virtex FPGA and contains Virtex
198 // specific elements.
199
200 // Ethernet implemented in Altera Chips (uncomment following lines)
201 //`define ETH_ALTERA_ALTSYNCRAM
202
203 // Ethernet implemented in ASIC with Virtual Silicon RAMs
204 // `define ETH_VIRTUAL_SILICON_RAM // Virtual Silicon RAMS used storing buffer decriptors (ASIC implementation)
205
206 // Ethernet implemented in ASIC with Artisan RAMs
207 // `define ETH_ARTISAN_RAM // Artisan RAMS used storing buffer decriptors (ASIC implementation)
208
209 // Uncomment when Avalon bus is used
210 //`define ETH_AVALON_BUS
211
212 `define ETH_MODER_ADR 8'h0 // 0x0
213 `define ETH_INT_SOURCE_ADR 8'h1 // 0x4
214 `define ETH_INT_MASK_ADR 8'h2 // 0x8
215 `define ETH_IPGT_ADR 8'h3 // 0xC
216 `define ETH_IPGR1_ADR 8'h4 // 0x10
217 `define ETH_IPGR2_ADR 8'h5 // 0x14
218 `define ETH_PACKETLEN_ADR 8'h6 // 0x18
219 `define ETH_COLLCONF_ADR 8'h7 // 0x1C
220 `define ETH_TX_BD_NUM_ADR 8'h8 // 0x20
221 `define ETH_CTRLMODER_ADR 8'h9 // 0x24
222 `define ETH_MIIMODER_ADR 8'hA // 0x28
223 `define ETH_MIICOMMAND_ADR 8'hB // 0x2C
224 `define ETH_MIIADDRESS_ADR 8'hC // 0x30
225 `define ETH_MIITX_DATA_ADR 8'hD // 0x34
226 `define ETH_MIIRX_DATA_ADR 8'hE // 0x38
227 `define ETH_MIISTATUS_ADR 8'hF // 0x3C
228 `define ETH_MAC_ADDR0_ADR 8'h10 // 0x40
229 `define ETH_MAC_ADDR1_ADR 8'h11 // 0x44
230 `define ETH_HASH0_ADR 8'h12 // 0x48
231 `define ETH_HASH1_ADR 8'h13 // 0x4C
232 `define ETH_TX_CTRL_ADR 8'h14 // 0x50
233 `define ETH_RX_CTRL_ADR 8'h15 // 0x54
234
235
236 `define ETH_MODER_DEF_0 8'h00
237 `define ETH_MODER_DEF_1 8'hA0
238 `define ETH_MODER_DEF_2 1'h0
239 `define ETH_INT_MASK_DEF_0 7'h0
240 `define ETH_IPGT_DEF_0 7'h12
241 `define ETH_IPGR1_DEF_0 7'h0C
242 `define ETH_IPGR2_DEF_0 7'h12
243 `define ETH_PACKETLEN_DEF_0 8'h00
244 `define ETH_PACKETLEN_DEF_1 8'h06
245 `define ETH_PACKETLEN_DEF_2 8'h40
246 `define ETH_PACKETLEN_DEF_3 8'h00
247 `define ETH_COLLCONF_DEF_0 6'h3f
248 `define ETH_COLLCONF_DEF_2 4'hF
249 `define ETH_TX_BD_NUM_DEF_0 8'h40
250 `define ETH_CTRLMODER_DEF_0 3'h0
251 `define ETH_MIIMODER_DEF_0 8'h64
252 `define ETH_MIIMODER_DEF_1 1'h0
253 `define ETH_MIIADDRESS_DEF_0 5'h00
254 `define ETH_MIIADDRESS_DEF_1 5'h00
255 `define ETH_MIITX_DATA_DEF_0 8'h00
256 `define ETH_MIITX_DATA_DEF_1 8'h00
257 `define ETH_MIIRX_DATA_DEF 16'h0000 // not written from WB
258 `define ETH_MAC_ADDR0_DEF_0 8'h00
259 `define ETH_MAC_ADDR0_DEF_1 8'h00
260 `define ETH_MAC_ADDR0_DEF_2 8'h00
261 `define ETH_MAC_ADDR0_DEF_3 8'h00
262 `define ETH_MAC_ADDR1_DEF_0 8'h00
263 `define ETH_MAC_ADDR1_DEF_1 8'h00
264 `define ETH_HASH0_DEF_0 8'h00
265 `define ETH_HASH0_DEF_1 8'h00
266 `define ETH_HASH0_DEF_2 8'h00
267 `define ETH_HASH0_DEF_3 8'h00
268 `define ETH_HASH1_DEF_0 8'h00
269 `define ETH_HASH1_DEF_1 8'h00
270 `define ETH_HASH1_DEF_2 8'h00
271 `define ETH_HASH1_DEF_3 8'h00
272 `define ETH_TX_CTRL_DEF_0 8'h00 //
273 `define ETH_TX_CTRL_DEF_1 8'h00 //
274 `define ETH_TX_CTRL_DEF_2 1'h0 //
275 `define ETH_RX_CTRL_DEF_0 8'h00
276 `define ETH_RX_CTRL_DEF_1 8'h00
277
278
279 `define ETH_MODER_WIDTH_0 8
280 `define ETH_MODER_WIDTH_1 8
281 `define ETH_MODER_WIDTH_2 1
282 `define ETH_INT_SOURCE_WIDTH_0 7
283 `define ETH_INT_MASK_WIDTH_0 7
284 `define ETH_IPGT_WIDTH_0 7
285 `define ETH_IPGR1_WIDTH_0 7
286 `define ETH_IPGR2_WIDTH_0 7
287 `define ETH_PACKETLEN_WIDTH_0 8
288 `define ETH_PACKETLEN_WIDTH_1 8
289 `define ETH_PACKETLEN_WIDTH_2 8
290 `define ETH_PACKETLEN_WIDTH_3 8
291 `define ETH_COLLCONF_WIDTH_0 6
292 `define ETH_COLLCONF_WIDTH_2 4
293 `define ETH_TX_BD_NUM_WIDTH_0 8
294 `define ETH_CTRLMODER_WIDTH_0 3
295 `define ETH_MIIMODER_WIDTH_0 8
296 `define ETH_MIIMODER_WIDTH_1 1
297 `define ETH_MIICOMMAND_WIDTH_0 3
298 `define ETH_MIIADDRESS_WIDTH_0 5
299 `define ETH_MIIADDRESS_WIDTH_1 5
300 `define ETH_MIITX_DATA_WIDTH_0 8
301 `define ETH_MIITX_DATA_WIDTH_1 8
302 `define ETH_MIIRX_DATA_WIDTH 16 // not written from WB
303 `define ETH_MIISTATUS_WIDTH 3 // not written from WB
304 `define ETH_MAC_ADDR0_WIDTH_0 8
305 `define ETH_MAC_ADDR0_WIDTH_1 8
306 `define ETH_MAC_ADDR0_WIDTH_2 8
307 `define ETH_MAC_ADDR0_WIDTH_3 8
308 `define ETH_MAC_ADDR1_WIDTH_0 8
309 `define ETH_MAC_ADDR1_WIDTH_1 8
310 `define ETH_HASH0_WIDTH_0 8
311 `define ETH_HASH0_WIDTH_1 8
312 `define ETH_HASH0_WIDTH_2 8
313 `define ETH_HASH0_WIDTH_3 8
314 `define ETH_HASH1_WIDTH_0 8
315 `define ETH_HASH1_WIDTH_1 8
316 `define ETH_HASH1_WIDTH_2 8
317 `define ETH_HASH1_WIDTH_3 8
318 `define ETH_TX_CTRL_WIDTH_0 8
319 `define ETH_TX_CTRL_WIDTH_1 8
320 `define ETH_TX_CTRL_WIDTH_2 1
321 `define ETH_RX_CTRL_WIDTH_0 8
322 `define ETH_RX_CTRL_WIDTH_1 8
323
324
325 // Outputs are registered (uncomment when needed)
326 `define ETH_REGISTERED_OUTPUTS
327
328 // Settings for TX FIFO
329 `define ETH_TX_FIFO_CNT_WIDTH 5
330 `define ETH_TX_FIFO_DEPTH 16
331 `define ETH_TX_FIFO_DATA_WIDTH 32
332
333 // Settings for RX FIFO
334 `define ETH_RX_FIFO_CNT_WIDTH 5
335 `define ETH_RX_FIFO_DEPTH 16
336 `define ETH_RX_FIFO_DATA_WIDTH 32
337
338 // Burst length
339 `define ETH_BURST_LENGTH 4 // Change also ETH_BURST_CNT_WIDTH
340 `define ETH_BURST_CNT_WIDTH 3 // The counter must be width enough to count to ETH_BURST_LENGTH
341
342 // WISHBONE interface is Revision B3 compliant (uncomment when needed)
343 `define ETH_WISHBONE_B3
344
345 // Following defines are needed when eth_cop.v is used. Otherwise they may be deleted.
346 `define ETH_BASE 32'hd0000000
347 `define ETH_WIDTH 32'h800
348 `define MEMORY_BASE 32'h2000
349 `define MEMORY_WIDTH 32'h10000
350
351 `define M1_ADDRESSED_S1 ( (m1_wb_adr_i >= `ETH_BASE) & (m1_wb_adr_i < (`ETH_BASE + `ETH_WIDTH )) )
352 `define M1_ADDRESSED_S2 ( (m1_wb_adr_i >= `MEMORY_BASE) & (m1_wb_adr_i < (`MEMORY_BASE + `MEMORY_WIDTH)) )
353 `define M2_ADDRESSED_S1 ( (m2_wb_adr_i >= `ETH_BASE) & (m2_wb_adr_i < (`ETH_BASE + `ETH_WIDTH )) )
354 `define M2_ADDRESSED_S2 ( (m2_wb_adr_i >= `MEMORY_BASE) & (m2_wb_adr_i < (`MEMORY_BASE + `MEMORY_WIDTH)) )
355 // Previous defines are only needed for eth_cop.v
356
Impressum, Datenschutz