xref: /freebsd/sys/dev/bfe/if_bfereg.h (revision 63a938566d524836885917d95bd491aa4400b181)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2003 Stuart Walsh
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  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS 'AS IS' AND
16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  */
27 /* $FreeBSD$ */
28 
29 #ifndef _BFE_H
30 #define _BFE_H
31 
32 /* PCI registers */
33 #define BFE_PCI_MEMLO           0x10
34 #define BFE_PCI_MEMHIGH         0x14
35 #define BFE_PCI_INTLINE         0x3C
36 
37 /* Register layout. */
38 #define BFE_DEVCTRL         0x00000000  /* Device Control */
39 #define BFE_PFE             0x00000080  /* Pattern Filtering Enable */
40 #define BFE_IPP             0x00000400  /* Internal EPHY Present */
41 #define BFE_EPR             0x00008000  /* EPHY Reset */
42 #define BFE_PME             0x00001000  /* PHY Mode Enable */
43 #define BFE_PMCE            0x00002000  /* PHY Mode Clocks Enable */
44 #define BFE_PADDR           0x0007c000  /* PHY Address */
45 #define BFE_PADDR_SHIFT     18
46 
47 #define BFE_BIST_STAT       0x0000000C  /* Built-In Self-Test Status */
48 #define BFE_WKUP_LEN        0x00000010  /* Wakeup Length */
49 
50 #define BFE_ISTAT           0x00000020  /* Interrupt Status */
51 #define BFE_ISTAT_PME       0x00000040 /* Power Management Event */
52 #define BFE_ISTAT_TO        0x00000080 /* General Purpose Timeout */
53 #define BFE_ISTAT_DSCE      0x00000400 /* Descriptor Error */
54 #define BFE_ISTAT_DATAE     0x00000800 /* Data Error */
55 #define BFE_ISTAT_DPE       0x00001000 /* Descr. Protocol Error */
56 #define BFE_ISTAT_RDU       0x00002000 /* Receive Descr. Underflow */
57 #define BFE_ISTAT_RFO       0x00004000 /* Receive FIFO Overflow */
58 #define BFE_ISTAT_TFU       0x00008000 /* Transmit FIFO Underflow */
59 #define BFE_ISTAT_RX        0x00010000 /* RX Interrupt */
60 #define BFE_ISTAT_TX        0x01000000 /* TX Interrupt */
61 #define BFE_ISTAT_EMAC      0x04000000 /* EMAC Interrupt */
62 #define BFE_ISTAT_MII_WRITE 0x08000000 /* MII Write Interrupt */
63 #define BFE_ISTAT_MII_READ  0x10000000 /* MII Read Interrupt */
64 #define BFE_ISTAT_ERRORS    (BFE_ISTAT_DSCE | BFE_ISTAT_DATAE | BFE_ISTAT_DPE |\
65 	BFE_ISTAT_RDU | BFE_ISTAT_RFO | BFE_ISTAT_TFU)
66 
67 #define BFE_IMASK           0x00000024 /* Interrupt Mask */
68 #define BFE_IMASK_DEF       (BFE_ISTAT_ERRORS | BFE_ISTAT_TO | BFE_ISTAT_RX | \
69 	BFE_ISTAT_TX)
70 
71 #define BFE_MAC_CTRL        0x000000A8 /* MAC Control */
72 #define BFE_CTRL_CRC32_ENAB 0x00000001 /* CRC32 Generation Enable */
73 #define BFE_CTRL_PDOWN      0x00000004 /* Onchip EPHY Powerdown */
74 #define BFE_CTRL_EDET       0x00000008 /* Onchip EPHY Energy Detected */
75 #define BFE_CTRL_LED        0x000000e0 /* Onchip EPHY LED Control */
76 #define BFE_CTRL_LED_SHIFT  5
77 
78 #define BFE_MAC_FLOW        0x000000AC /* MAC Flow Control */
79 #define BFE_FLOW_RX_HIWAT   0x000000ff /* Onchip FIFO HI Water Mark */
80 #define BFE_FLOW_PAUSE_ENAB 0x00008000 /* Enable Pause Frame Generation */
81 
82 #define BFE_RCV_LAZY        0x00000100 /* Lazy Interrupt Control */
83 #define BFE_LAZY_TO_MASK    0x00ffffff /* Timeout */
84 #define BFE_LAZY_FC_MASK    0xff000000 /* Frame Count */
85 #define BFE_LAZY_FC_SHIFT   24
86 
87 #define BFE_DMATX_CTRL      0x00000200 /* DMA TX Control */
88 #define BFE_TX_CTRL_ENABLE  0x00000001 /* Enable */
89 #define BFE_TX_CTRL_SUSPEND 0x00000002 /* Suepend Request */
90 #define BFE_TX_CTRL_LPBACK  0x00000004 /* Loopback Enable */
91 #define BFE_TX_CTRL_FAIRPRI 0x00000008 /* Fair Priority */
92 #define BFE_TX_CTRL_FLUSH   0x00000010 /* Flush Request */
93 
94 #define BFE_DMATX_ADDR      0x00000204 /* DMA TX Descriptor Ring Address */
95 #define BFE_DMATX_PTR       0x00000208 /* DMA TX Last Posted Descriptor */
96 #define BFE_DMATX_STAT      0x0000020C /* DMA TX Current Active Desc. + Status */
97 #define BFE_STAT_CDMASK     0x00000fff /* Current Descriptor Mask */
98 #define BFE_STAT_SMASK      0x0000f000 /* State Mask */
99 #define BFE_STAT_DISABLE    0x00000000 /* State Disabled */
100 #define BFE_STAT_SACTIVE    0x00001000 /* State Active */
101 #define BFE_STAT_SIDLE      0x00002000 /* State Idle Wait */
102 #define BFE_STAT_STOPPED    0x00003000 /* State Stopped */
103 #define BFE_STAT_SSUSP      0x00004000 /* State Suspend Pending */
104 #define BFE_STAT_EMASK      0x000f0000 /* Error Mask */
105 #define BFE_STAT_ENONE      0x00000000 /* Error None */
106 #define BFE_STAT_EDPE       0x00010000 /* Error Desc. Protocol Error */
107 #define BFE_STAT_EDFU       0x00020000 /* Error Data FIFO Underrun */
108 #define BFE_STAT_EBEBR      0x00030000 /* Error Bus Error on Buffer Read */
109 #define BFE_STAT_EBEDA      0x00040000 /* Error Bus Error on Desc. Access */
110 #define BFE_STAT_FLUSHED    0x00100000 /* Flushed */
111 
112 #define BFE_DMARX_CTRL      0x00000210 /* DMA RX Control */
113 #define BFE_RX_CTRL_ENABLE  0x00000001 /* Enable */
114 #define BFE_RX_CTRL_ROMASK  0x000000fe /* Receive Offset Mask */
115 #define BFE_RX_CTRL_ROSHIFT 1           /* Receive Offset Shift */
116 
117 #define BFE_DMARX_ADDR      0x00000214 /* DMA RX Descriptor Ring Address */
118 #define BFE_DMARX_PTR       0x00000218 /* DMA RX Last Posted Descriptor */
119 #define BFE_DMARX_STAT      0x0000021C /* DMA RX Current Active Desc. + Status */
120 
121 #define BFE_RXCONF          0x00000400 /* EMAC RX Config */
122 #define BFE_RXCONF_DBCAST   0x00000001 /* Disable Broadcast */
123 #define BFE_RXCONF_ALLMULTI 0x00000002 /* Accept All Multicast */
124 #define BFE_RXCONF_NORXTX   0x00000004 /* Receive Disable While Transmitting */
125 #define BFE_RXCONF_PROMISC  0x00000008 /* Promiscuous Enable */
126 #define BFE_RXCONF_LPBACK   0x00000010 /* Loopback Enable */
127 #define BFE_RXCONF_FLOW     0x00000020 /* Flow Control Enable */
128 #define BFE_RXCONF_ACCEPT   0x00000040 /* Accept Unicast Flow Control Frame */
129 #define BFE_RXCONF_RFILT    0x00000080 /* Reject Filter */
130 
131 #define BFE_RXMAXLEN        0x00000404 /* EMAC RX Max Packet Length */
132 #define BFE_TXMAXLEN        0x00000408 /* EMAC TX Max Packet Length */
133 
134 #define BFE_MDIO_CTRL       0x00000410 /* EMAC MDIO Control */
135 #define BFE_MDIO_MAXF_MASK  0x0000007f /* MDC Frequency */
136 #define BFE_MDIO_PREAMBLE   0x00000080 /* MII Preamble Enable */
137 
138 #define BFE_MDIO_DATA       0x00000414 /* EMAC MDIO Data */
139 #define BFE_MDIO_DATA_DATA  0x0000ffff /* R/W Data */
140 #define BFE_MDIO_TA_MASK    0x00030000 /* Turnaround Value */
141 #define BFE_MDIO_TA_SHIFT   16
142 #define BFE_MDIO_TA_VALID   2
143 
144 #define BFE_MDIO_RA_MASK    0x007c0000 /* Register Address */
145 #define BFE_MDIO_PMD_MASK   0x0f800000 /* Physical Media Device */
146 #define BFE_MDIO_OP_MASK    0x30000000 /* Opcode */
147 #define BFE_MDIO_SB_MASK    0xc0000000 /* Start Bits */
148 #define BFE_MDIO_SB_START   0x40000000 /* Start Of Frame */
149 #define BFE_MDIO_RA_SHIFT   18
150 #define BFE_MDIO_PMD_SHIFT  23
151 #define BFE_MDIO_OP_SHIFT   28
152 #define BFE_MDIO_OP_WRITE   1
153 #define BFE_MDIO_OP_READ    2
154 #define BFE_MDIO_SB_SHIFT   30
155 
156 #define BFE_EMAC_IMASK      0x00000418 /* EMAC Interrupt Mask */
157 #define BFE_EMAC_ISTAT      0x0000041C /* EMAC Interrupt Status */
158 #define BFE_EMAC_INT_MII    0x00000001 /* MII MDIO Interrupt */
159 #define BFE_EMAC_INT_MIB    0x00000002 /* MIB Interrupt */
160 #define BFE_EMAC_INT_FLOW   0x00000003 /* Flow Control Interrupt */
161 
162 #define BFE_CAM_DATA_LO     0x00000420 /* EMAC CAM Data Low */
163 #define BFE_CAM_DATA_HI     0x00000424 /* EMAC CAM Data High */
164 #define BFE_CAM_HI_VALID    0x00010000 /* Valid Bit */
165 
166 #define BFE_CAM_CTRL        0x00000428 /* EMAC CAM Control */
167 #define BFE_CAM_ENABLE      0x00000001 /* CAM Enable */
168 #define BFE_CAM_MSEL        0x00000002 /* Mask Select */
169 #define BFE_CAM_READ        0x00000004 /* Read */
170 #define BFE_CAM_WRITE       0x00000008 /* Read */
171 #define BFE_CAM_INDEX_MASK  0x003f0000 /* Index Mask */
172 #define BFE_CAM_BUSY        0x80000000 /* CAM Busy */
173 #define BFE_CAM_INDEX_SHIFT 16
174 
175 #define BFE_ENET_CTRL       0x0000042C /* EMAC ENET Control */
176 #define BFE_ENET_ENABLE     0x00000001 /* EMAC Enable */
177 #define BFE_ENET_DISABLE    0x00000002 /* EMAC Disable */
178 #define BFE_ENET_SRST       0x00000004 /* EMAC Soft Reset */
179 #define BFE_ENET_EPSEL      0x00000008 /* External PHY Select */
180 
181 #define BFE_TX_CTRL         0x00000430 /* EMAC TX Control */
182 #define BFE_TX_DUPLEX       0x00000001 /* Full Duplex */
183 #define BFE_TX_FMODE        0x00000002 /* Flow Mode */
184 #define BFE_TX_SBENAB       0x00000004 /* Single Backoff Enable */
185 #define BFE_TX_SMALL_SLOT   0x00000008 /* Small Slottime */
186 
187 #define BFE_TX_WMARK        0x00000434 /* EMAC TX Watermark */
188 
189 #define BFE_MIB_CTRL        0x00000438 /* EMAC MIB Control */
190 #define BFE_MIB_CLR_ON_READ 0x00000001 /* Autoclear on Read */
191 
192 /* Status registers */
193 #define BFE_TX_GOOD_O       0x00000500 /* MIB TX Good Octets */
194 #define BFE_TX_GOOD_P       0x00000504 /* MIB TX Good Packets */
195 #define BFE_TX_O            0x00000508 /* MIB TX Octets */
196 #define BFE_TX_P            0x0000050C /* MIB TX Packets */
197 #define BFE_TX_BCAST        0x00000510 /* MIB TX Broadcast Packets */
198 #define BFE_TX_MCAST        0x00000514 /* MIB TX Multicast Packets */
199 #define BFE_TX_64           0x00000518 /* MIB TX <= 64 byte Packets */
200 #define BFE_TX_65_127       0x0000051C /* MIB TX 65 to 127 byte Packets */
201 #define BFE_TX_128_255      0x00000520 /* MIB TX 128 to 255 byte Packets */
202 #define BFE_TX_256_511      0x00000524 /* MIB TX 256 to 511 byte Packets */
203 #define BFE_TX_512_1023     0x00000528 /* MIB TX 512 to 1023 byte Packets */
204 #define BFE_TX_1024_MAX     0x0000052C /* MIB TX 1024 to max byte Packets */
205 #define BFE_TX_JABBER       0x00000530 /* MIB TX Jabber Packets */
206 #define BFE_TX_OSIZE        0x00000534 /* MIB TX Oversize Packets */
207 #define BFE_TX_FRAG         0x00000538 /* MIB TX Fragment Packets */
208 #define BFE_TX_URUNS        0x0000053C /* MIB TX Underruns */
209 #define BFE_TX_TCOLS        0x00000540 /* MIB TX Total Collisions */
210 #define BFE_TX_SCOLS        0x00000544 /* MIB TX Single Collisions */
211 #define BFE_TX_MCOLS        0x00000548 /* MIB TX Multiple Collisions */
212 #define BFE_TX_ECOLS        0x0000054C /* MIB TX Excessive Collisions */
213 #define BFE_TX_LCOLS        0x00000550 /* MIB TX Late Collisions */
214 #define BFE_TX_DEFERED      0x00000554 /* MIB TX Defered Packets */
215 #define BFE_TX_CLOST        0x00000558 /* MIB TX Carrier Lost */
216 #define BFE_TX_PAUSE        0x0000055C /* MIB TX Pause Packets */
217 #define BFE_RX_GOOD_O       0x00000580 /* MIB RX Good Octets */
218 #define BFE_RX_GOOD_P       0x00000584 /* MIB RX Good Packets */
219 #define BFE_RX_O            0x00000588 /* MIB RX Octets */
220 #define BFE_RX_P            0x0000058C /* MIB RX Packets */
221 #define BFE_RX_BCAST        0x00000590 /* MIB RX Broadcast Packets */
222 #define BFE_RX_MCAST        0x00000594 /* MIB RX Multicast Packets */
223 #define BFE_RX_64           0x00000598 /* MIB RX <= 64 byte Packets */
224 #define BFE_RX_65_127       0x0000059C /* MIB RX 65 to 127 byte Packets */
225 #define BFE_RX_128_255      0x000005A0 /* MIB RX 128 to 255 byte Packets */
226 #define BFE_RX_256_511      0x000005A4 /* MIB RX 256 to 511 byte Packets */
227 #define BFE_RX_512_1023     0x000005A8 /* MIB RX 512 to 1023 byte Packets */
228 #define BFE_RX_1024_MAX     0x000005AC /* MIB RX 1024 to max byte Packets */
229 #define BFE_RX_JABBER       0x000005B0 /* MIB RX Jabber Packets */
230 #define BFE_RX_OSIZE        0x000005B4 /* MIB RX Oversize Packets */
231 #define BFE_RX_FRAG         0x000005B8 /* MIB RX Fragment Packets */
232 #define BFE_RX_MISS         0x000005BC /* MIB RX Missed Packets */
233 #define BFE_RX_CRCA         0x000005C0 /* MIB RX CRC Align Errors */
234 #define BFE_RX_USIZE        0x000005C4 /* MIB RX Undersize Packets */
235 #define BFE_RX_CRC          0x000005C8 /* MIB RX CRC Errors */
236 #define BFE_RX_ALIGN        0x000005CC /* MIB RX Align Errors */
237 #define BFE_RX_SYM          0x000005D0 /* MIB RX Symbol Errors */
238 #define BFE_RX_PAUSE        0x000005D4 /* MIB RX Pause Packets */
239 #define BFE_RX_NPAUSE       0x000005D8 /* MIB RX Non-Pause Packets */
240 
241 #define BFE_SBIMSTATE       0x00000F90 /* BFE_SB Initiator Agent State */
242 #define BFE_PC              0x0000000f /* Pipe Count */
243 #define BFE_AP_MASK         0x00000030 /* Arbitration Priority */
244 #define BFE_AP_BOTH         0x00000000 /* Use both timeslices and token */
245 #define BFE_AP_TS           0x00000010 /* Use timeslices only */
246 #define BFE_AP_TK           0x00000020 /* Use token only */
247 #define BFE_AP_RSV          0x00000030 /* Reserved */
248 #define BFE_IBE             0x00020000 /* In Band Error */
249 #define BFE_TO              0x00040000 /* Timeout */
250 
251 
252 /* Seems the bcm440x has a fairly generic core, we only need be concerned with
253  * a couple of these
254  */
255 #define BFE_SBINTVEC        0x00000F94 /* BFE_SB Interrupt Mask */
256 #define BFE_INTVEC_PCI      0x00000001 /* Enable interrupts for PCI */
257 #define BFE_INTVEC_ENET0    0x00000002 /* Enable interrupts for enet 0 */
258 #define BFE_INTVEC_ILINE20  0x00000004 /* Enable interrupts for iline20 */
259 #define BFE_INTVEC_CODEC    0x00000008 /* Enable interrupts for v90 codec */
260 #define BFE_INTVEC_USB      0x00000010 /* Enable interrupts for usb */
261 #define BFE_INTVEC_EXTIF    0x00000020 /* Enable interrupts for external i/f */
262 #define BFE_INTVEC_ENET1    0x00000040 /* Enable interrupts for enet 1 */
263 
264 #define BFE_SBTMSLOW        0x00000F98 /* BFE_SB Target State Low */
265 #define BFE_RESET           0x00000001 /* Reset */
266 #define BFE_REJECT          0x00000002 /* Reject */
267 #define BFE_CLOCK           0x00010000 /* Clock Enable */
268 #define BFE_FGC             0x00020000 /* Force Gated Clocks On */
269 #define BFE_PE              0x40000000 /* Power Management Enable */
270 #define BFE_BE              0x80000000 /* BIST Enable */
271 
272 #define BFE_SBTMSHIGH       0x00000F9C /* BFE_SB Target State High */
273 #define BFE_SERR            0x00000001 /* S-error */
274 #define BFE_INT             0x00000002 /* Interrupt */
275 #define BFE_BUSY            0x00000004 /* Busy */
276 #define BFE_GCR             0x20000000 /* Gated Clock Request */
277 #define BFE_BISTF           0x40000000 /* BIST Failed */
278 #define BFE_BISTD           0x80000000 /* BIST Done */
279 
280 #define BFE_SBBWA0          0x00000FA0 /* BFE_SB Bandwidth Allocation Table 0 */
281 #define BFE_TAB0_MASK       0x0000ffff /* Lookup Table 0 */
282 #define BFE_TAB1_MASK       0xffff0000 /* Lookup Table 0 */
283 #define BFE_TAB0_SHIFT      0
284 #define BFE_TAB1_SHIFT      16
285 
286 #define BFE_SBIMCFGLOW      0x00000FA8 /* BFE_SB Initiator Configuration Low */
287 #define BFE_STO_MASK        0x00000003 /* Service Timeout */
288 #define BFE_RTO_MASK        0x00000030 /* Request Timeout */
289 #define BFE_CID_MASK        0x00ff0000 /* Connection ID */
290 #define BFE_RTO_SHIFT       4
291 #define BFE_CID_SHIFT       16
292 
293 #define BFE_SBIMCFGHIGH     0x00000FAC /* BFE_SB Initiator Configuration High */
294 #define BFE_IEM_MASK        0x0000000c /* Inband Error Mode */
295 #define BFE_TEM_MASK        0x00000030 /* Timeout Error Mode */
296 #define BFE_BEM_MASK        0x000000c0 /* Bus Error Mode */
297 #define BFE_TEM_SHIFT       4
298 #define BFE_BEM_SHIFT       6
299 
300 #define BFE_SBTMCFGLOW      0x00000FB8 /* BFE_SB Target Configuration Low */
301 #define BFE_LOW_CD_MASK     0x000000ff /* Clock Divide Mask */
302 #define BFE_LOW_CO_MASK     0x0000f800 /* Clock Offset Mask */
303 #define BFE_LOW_IF_MASK     0x00fc0000 /* Interrupt Flags Mask */
304 #define BFE_LOW_IM_MASK     0x03000000 /* Interrupt Mode Mask */
305 #define BFE_LOW_CO_SHIFT    11
306 #define BFE_LOW_IF_SHIFT    18
307 #define BFE_LOW_IM_SHIFT    24
308 
309 #define BFE_SBTMCFGHIGH     0x00000FBC /* BFE_SB Target Configuration High */
310 #define BFE_HIGH_BM_MASK    0x00000003 /* Busy Mode */
311 #define BFE_HIGH_RM_MASK    0x0000000C /* Retry Mode */
312 #define BFE_HIGH_SM_MASK    0x00000030 /* Stop Mode */
313 #define BFE_HIGH_EM_MASK    0x00000300 /* Error Mode */
314 #define BFE_HIGH_IM_MASK    0x00000c00 /* Interrupt Mode */
315 #define BFE_HIGH_RM_SHIFT   2
316 #define BFE_HIGH_SM_SHIFT   4
317 #define BFE_HIGH_EM_SHIFT   8
318 #define BFE_HIGH_IM_SHIFT   10
319 
320 #define BFE_SBBCFG          0x00000FC0 /* BFE_SB Broadcast Configuration */
321 #define BFE_LAT_MASK        0x00000003 /* BFE_SB Latency */
322 #define BFE_MAX0_MASK       0x000f0000 /* MAX Counter 0 */
323 #define BFE_MAX1_MASK       0x00f00000 /* MAX Counter 1 */
324 #define BFE_MAX0_SHIFT      16
325 #define BFE_MAX1_SHIFT      20
326 
327 #define BFE_SBBSTATE        0x00000FC8 /* BFE_SB Broadcast State */
328 #define BFE_SBBSTATE_SRD    0x00000001 /* ST Reg Disable */
329 #define BFE_SBBSTATE_HRD    0x00000002 /* Hold Reg Disable */
330 
331 #define BFE_SBACTCNFG       0x00000FD8 /* BFE_SB Activate Configuration */
332 #define BFE_SBFLAGST        0x00000FE8 /* BFE_SB Current BFE_SBFLAGS */
333 
334 #define BFE_SBIDLOW         0x00000FF8 /* BFE_SB Identification Low */
335 #define BFE_CS_MASK         0x00000003 /* Config Space Mask */
336 #define BFE_AR_MASK         0x00000038 /* Num Address Ranges Supported */
337 #define BFE_SYNCH           0x00000040 /* Sync */
338 #define BFE_INIT            0x00000080 /* Initiator */
339 #define BFE_MINLAT_MASK     0x00000f00 /* Minimum Backplane Latency */
340 #define BFE_MAXLAT_MASK     0x0000f000 /* Maximum Backplane Latency */
341 #define BFE_FIRST           0x00010000 /* This Initiator is First */
342 #define BFE_CW_MASK         0x000c0000 /* Cycle Counter Width */
343 #define BFE_TP_MASK         0x00f00000 /* Target Ports */
344 #define BFE_IP_MASK         0x0f000000 /* Initiator Ports */
345 #define BFE_AR_SHIFT        3
346 #define BFE_MINLAT_SHIFT    8
347 #define BFE_MAXLAT_SHIFT    12
348 #define BFE_CW_SHIFT        18
349 #define BFE_TP_SHIFT        20
350 #define BFE_IP_SHIFT        24
351 
352 #define BFE_SBIDHIGH        0x00000FFC /* BFE_SB Identification High */
353 #define BFE_RC_MASK         0x0000000f /* Revision Code */
354 #define BFE_CC_MASK         0x0000fff0 /* Core Code */
355 #define BFE_VC_MASK         0xffff0000 /* Vendor Code */
356 #define BFE_CC_SHIFT        4
357 #define BFE_VC_SHIFT        16
358 
359 #define BFE_CORE_ILINE20    0x801
360 #define BFE_CORE_SDRAM      0x803
361 #define BFE_CORE_PCI        0x804
362 #define BFE_CORE_MIPS       0x805
363 #define BFE_CORE_ENET       0x806
364 #define BFE_CORE_CODEC      0x807
365 #define BFE_CORE_USB        0x808
366 #define BFE_CORE_ILINE100   0x80a
367 #define BFE_CORE_EXTIF      0x811
368 
369 /* SSB PCI config space registers.  */
370 #define BFE_BAR0_WIN        0x80
371 #define BFE_BAR1_WIN        0x84
372 #define BFE_SPROM_CONTROL   0x88
373 #define BFE_BAR1_CONTROL    0x8c
374 
375 /* SSB core and hsot control registers.  */
376 #define BFE_SSB_CONTROL     0x00000000
377 #define BFE_SSB_ARBCONTROL  0x00000010
378 #define BFE_SSB_ISTAT       0x00000020
379 #define BFE_SSB_IMASK       0x00000024
380 #define BFE_SSB_MBOX        0x00000028
381 #define BFE_SSB_BCAST_ADDR  0x00000050
382 #define BFE_SSB_BCAST_DATA  0x00000054
383 #define BFE_SSB_PCI_TRANS_0 0x00000100
384 #define BFE_SSB_PCI_TRANS_1 0x00000104
385 #define BFE_SSB_PCI_TRANS_2 0x00000108
386 #define BFE_SSB_SPROM       0x00000800
387 
388 #define BFE_SSB_PCI_MEM     0x00000000
389 #define BFE_SSB_PCI_IO      0x00000001
390 #define BFE_SSB_PCI_CFG0    0x00000002
391 #define BFE_SSB_PCI_CFG1    0x00000003
392 #define BFE_SSB_PCI_PREF    0x00000004
393 #define BFE_SSB_PCI_BURST   0x00000008
394 #define BFE_SSB_PCI_MASK0   0xfc000000
395 #define BFE_SSB_PCI_MASK1   0xfc000000
396 #define BFE_SSB_PCI_MASK2   0xc0000000
397 
398 #define BFE_DESC_LEN        0x00001fff
399 #define BFE_DESC_CMASK      0x0ff00000 /* Core specific bits */
400 #define BFE_DESC_EOT        0x10000000 /* End of Table */
401 #define BFE_DESC_IOC        0x20000000 /* Interrupt On Completion */
402 #define BFE_DESC_EOF        0x40000000 /* End of Frame */
403 #define BFE_DESC_SOF        0x80000000 /* Start of Frame */
404 
405 #define BFE_RX_CP_THRESHOLD 256
406 #define BFE_RX_HEADER_LEN   28
407 
408 #define BFE_RX_FLAG_OFIFO   0x00000001 /* FIFO Overflow */
409 #define BFE_RX_FLAG_CRCERR  0x00000002 /* CRC Error */
410 #define BFE_RX_FLAG_SERR    0x00000004 /* Receive Symbol Error */
411 #define BFE_RX_FLAG_ODD     0x00000008 /* Frame has odd number of nibbles */
412 #define BFE_RX_FLAG_LARGE   0x00000010 /* Frame is > RX MAX Length */
413 #define BFE_RX_FLAG_MCAST   0x00000020 /* Dest is Multicast Address */
414 #define BFE_RX_FLAG_BCAST   0x00000040 /* Dest is Broadcast Address */
415 #define BFE_RX_FLAG_MISS    0x00000080 /* Received due to promisc mode */
416 #define BFE_RX_FLAG_LAST    0x00000800 /* Last buffer in frame */
417 #define BFE_RX_FLAG_ERRORS  (BFE_RX_FLAG_ODD | BFE_RX_FLAG_SERR |           \
418 	BFE_RX_FLAG_CRCERR | BFE_RX_FLAG_OFIFO)
419 
420 #define BFE_MCAST_TBL_SIZE  32
421 #define BFE_PCI_DMA         0x40000000
422 #define BFE_REG_PCI         0x18002000
423 
424 #define BCOM_VENDORID           0x14E4
425 #define BCOM_DEVICEID_BCM4401   0x4401
426 #define BCOM_DEVICEID_BCM4401B0	0x170c
427 
428 #define PCI_SETBIT(dev, reg, x, s)  \
429     pci_write_config(dev, reg, (pci_read_config(dev, reg, s) | (x)), s)
430 #define PCI_CLRBIT(dev, reg, x, s)  \
431     pci_write_config(dev, reg, (pci_read_config(dev, reg, s) & ~(x)), s)
432 
433 #define BFE_TX_LIST_CNT         128
434 #define BFE_RX_LIST_CNT         128
435 #define BFE_TX_LIST_SIZE        BFE_TX_LIST_CNT * sizeof(struct bfe_desc)
436 #define BFE_RX_LIST_SIZE        BFE_RX_LIST_CNT * sizeof(struct bfe_desc)
437 #define BFE_RX_OFFSET           30
438 #define BFE_TX_QLEN             256
439 
440 #define	BFE_RX_RING_ALIGN	4096
441 #define	BFE_TX_RING_ALIGN	4096
442 #define	BFE_MAXTXSEGS		16
443 #define	BFE_DMA_MAXADDR		0x3FFFFFFF	/* 1GB DMA address limit. */
444 #define	BFE_ADDR_LO(x)		((uint64_t)(x) & 0xFFFFFFFF)
445 
446 #define CSR_READ_4(sc, reg)		bus_read_4(sc->bfe_res, reg)
447 
448 #define CSR_WRITE_4(sc, reg, val)	bus_write_4(sc->bfe_res, reg, val)
449 
450 #define BFE_OR(sc, name, val)                                               \
451 	CSR_WRITE_4(sc, name, CSR_READ_4(sc, name) | val)
452 
453 #define BFE_AND(sc, name, val)                                              \
454 	CSR_WRITE_4(sc, name, CSR_READ_4(sc, name) & val)
455 
456 #define BFE_LOCK_ASSERT(_sc)	mtx_assert(&(_sc)->bfe_mtx, MA_OWNED)
457 #define BFE_LOCK(_sc)		mtx_lock(&(_sc)->bfe_mtx)
458 #define BFE_UNLOCK(_sc)		mtx_unlock(&(_sc)->bfe_mtx)
459 
460 #define BFE_INC(x, y)       (x) = ((x) == ((y)-1)) ? 0 : (x)+1
461 
462 struct bfe_tx_data {
463     struct mbuf     *bfe_mbuf;
464     bus_dmamap_t     bfe_map;
465 };
466 
467 struct bfe_rx_data {
468     struct mbuf     *bfe_mbuf;
469     bus_dmamap_t     bfe_map;
470     u_int32_t        bfe_ctrl;
471 };
472 
473 struct bfe_desc {
474     u_int32_t         bfe_ctrl;
475     u_int32_t         bfe_addr;
476 };
477 
478 struct bfe_rxheader {
479     u_int16_t    len;
480     u_int16_t    flags;
481     u_int16_t    pad[12];
482 };
483 
484 #define MIB_TX_GOOD_O		0
485 #define MIB_TX_GOOD_P		1
486 #define MIB_TX_O		2
487 #define MIB_TX_P		3
488 #define MIB_TX_BCAST		4
489 #define MIB_TX_MCAST		5
490 #define MIB_TX_64		6
491 #define MIB_TX_65_127		7
492 #define MIB_TX_128_255		8
493 #define MIB_TX_256_511		9
494 #define MIB_TX_512_1023		10
495 #define MIB_TX_1024_MAX		11
496 #define MIB_TX_JABBER		12
497 #define MIB_TX_OSIZE		13
498 #define MIB_TX_FRAG		14
499 #define MIB_TX_URUNS		15
500 #define MIB_TX_TCOLS		16
501 #define MIB_TX_SCOLS		17
502 #define MIB_TX_MCOLS		18
503 #define MIB_TX_ECOLS		19
504 #define MIB_TX_LCOLS		20
505 #define MIB_TX_DEFERED		21
506 #define MIB_TX_CLOST		22
507 #define MIB_TX_PAUSE		23
508 #define MIB_RX_GOOD_O		24
509 #define MIB_RX_GOOD_P		25
510 #define MIB_RX_O		26
511 #define MIB_RX_P		27
512 #define MIB_RX_BCAST		28
513 #define MIB_RX_MCAST		29
514 #define MIB_RX_64		30
515 #define MIB_RX_65_127		31
516 #define MIB_RX_128_255		32
517 #define MIB_RX_256_511		33
518 #define MIB_RX_512_1023		34
519 #define MIB_RX_1024_MAX		35
520 #define MIB_RX_JABBER		36
521 #define MIB_RX_OSIZE		37
522 #define MIB_RX_FRAG		38
523 #define MIB_RX_MISS		39
524 #define MIB_RX_CRCA		40
525 #define MIB_RX_USIZE		41
526 #define MIB_RX_CRC		42
527 #define MIB_RX_ALIGN		43
528 #define MIB_RX_SYM		44
529 #define MIB_RX_PAUSE		45
530 #define MIB_RX_NPAUSE		46
531 
532 #define	BFE_MIB_CNT		(MIB_RX_NPAUSE - MIB_TX_GOOD_O + 1)
533 
534 struct bfe_hw_stats {
535     uint64_t	tx_good_octets;
536     uint64_t	tx_good_frames;
537     uint64_t	tx_octets;
538     uint64_t	tx_frames;
539     uint64_t	tx_bcast_frames;
540     uint64_t	tx_mcast_frames;
541     uint64_t	tx_pkts_64;
542     uint64_t	tx_pkts_65_127;
543     uint64_t	tx_pkts_128_255;
544     uint64_t	tx_pkts_256_511;
545     uint64_t	tx_pkts_512_1023;
546     uint64_t	tx_pkts_1024_max;
547     uint32_t	tx_jabbers;
548     uint64_t	tx_oversize_frames;
549     uint64_t	tx_frag_frames;
550     uint32_t	tx_underruns;
551     uint32_t	tx_colls;
552     uint32_t	tx_single_colls;
553     uint32_t	tx_multi_colls;
554     uint32_t	tx_excess_colls;
555     uint32_t	tx_late_colls;
556     uint32_t	tx_deferrals;
557     uint32_t	tx_carrier_losts;
558     uint32_t	tx_pause_frames;
559 
560     uint64_t	rx_good_octets;
561     uint64_t	rx_good_frames;
562     uint64_t	rx_octets;
563     uint64_t	rx_frames;
564     uint64_t	rx_bcast_frames;
565     uint64_t	rx_mcast_frames;
566     uint64_t	rx_pkts_64;
567     uint64_t	rx_pkts_65_127;
568     uint64_t	rx_pkts_128_255;
569     uint64_t	rx_pkts_256_511;
570     uint64_t	rx_pkts_512_1023;
571     uint64_t	rx_pkts_1024_max;
572     uint32_t	rx_jabbers;
573     uint64_t	rx_oversize_frames;
574     uint64_t	rx_frag_frames;
575     uint32_t	rx_missed_frames;
576     uint32_t	rx_crc_align_errs;
577     uint32_t	rx_runts;
578     uint32_t	rx_crc_errs;
579     uint32_t	rx_align_errs;
580     uint32_t	rx_symbol_errs;
581     uint32_t	rx_pause_frames;
582     uint32_t	rx_control_frames;
583 };
584 
585 struct bfe_softc
586 {
587     struct ifnet            *bfe_ifp;     /* interface info */
588     device_t                bfe_dev;
589     device_t                bfe_miibus;
590     bus_dma_tag_t           bfe_tag;
591     bus_dma_tag_t           bfe_parent_tag;
592     bus_dma_tag_t           bfe_tx_tag, bfe_rx_tag;
593     bus_dmamap_t            bfe_tx_map, bfe_rx_map;
594     bus_dma_tag_t           bfe_txmbuf_tag, bfe_rxmbuf_tag;
595     bus_dmamap_t            bfe_rx_sparemap;
596     void                    *bfe_intrhand;
597     struct resource         *bfe_irq;
598     struct resource         *bfe_res;
599     struct callout          bfe_stat_co;
600     struct bfe_hw_stats     bfe_stats;
601     struct bfe_desc         *bfe_tx_list, *bfe_rx_list;
602     struct bfe_tx_data      bfe_tx_ring[BFE_TX_LIST_CNT]; /* XXX */
603     struct bfe_rx_data      bfe_rx_ring[BFE_RX_LIST_CNT]; /* XXX */
604     struct mtx              bfe_mtx;
605     u_int32_t               bfe_flags;
606 #define	BFE_FLAG_DETACH		0x4000
607 #define	BFE_FLAG_LINK		0x8000
608     u_int32_t               bfe_imask;
609     u_int32_t               bfe_dma_offset;
610     u_int32_t               bfe_tx_cnt, bfe_tx_cons, bfe_tx_prod;
611     u_int32_t               bfe_rx_prod, bfe_rx_cons;
612     u_int32_t               bfe_tx_dma, bfe_rx_dma;
613     int                     bfe_watchdog_timer;
614     u_int8_t                bfe_phyaddr; /* Address of the card's PHY */
615     u_int8_t                bfe_mdc_port;
616     u_int8_t                bfe_core_unit;
617     u_char                  bfe_enaddr[6];
618     int                     bfe_if_flags;
619 };
620 
621 struct bfe_type
622 {
623     u_int16_t   bfe_vid;
624     u_int16_t   bfe_did;
625     char        *bfe_name;
626 };
627 
628 #endif /* _BFE_H */
629