xref: /freebsd-14-stable/sys/dev/dwc/if_dwc.h (revision 95ee2897e98f5d444f26ed2334cc7c439f9c16c6)
1 /*-
2  * Copyright (c) 2014 Ruslan Bukin <br@bsdpad.com>
3  * All rights reserved.
4  *
5  * This software was developed by SRI International and the University of
6  * Cambridge Computer Laboratory under DARPA/AFRL contract (FA8750-10-C-0237)
7  * ("CTSRD"), as part of the DARPA CRASH research programme.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28  * SUCH DAMAGE.
29  */
30 
31 /*
32  * Register names were taken almost as is from the documentation.
33  */
34 
35 #ifndef __IF_DWC_H__
36 #define __IF_DWC_H__
37 
38 #define	PHY_MODE_UNKNOWN	0x0
39 #define	PHY_MODE_RMII		0x1
40 #define	PHY_MODE_RGMII		0x2
41 #define	PHY_MODE_MII		0x3
42 
43 #define	MAC_CONFIGURATION	0x0
44 #define	 CONF_JD		(1 << 22)	/* jabber timer disable */
45 #define	 CONF_BE		(1 << 21)	/* Frame Burst Enable */
46 #define	 CONF_PS		(1 << 15)	/* GMII/MII */
47 #define	 CONF_FES		(1 << 14)	/* MII speed select */
48 #define	 CONF_DM		(1 << 11)	/* Full Duplex Enable */
49 #define	 CONF_IPC		(1 << 10)	/* IPC checksum offload */
50 #define	 CONF_ACS		(1 << 7)
51 #define	 CONF_TE		(1 << 3)
52 #define	 CONF_RE		(1 << 2)
53 #define	MAC_FRAME_FILTER	0x4
54 #define	 FRAME_FILTER_RA	(1U << 31)	/* Receive All */
55 #define	 FRAME_FILTER_HPF	(1 << 10)	/* Hash or Perfect Filter */
56 #define	 FRAME_FILTER_PM	(1 << 4)	/* Pass multicast */
57 #define	 FRAME_FILTER_HMC	(1 << 2)
58 #define	 FRAME_FILTER_HUC	(1 << 1)
59 #define	 FRAME_FILTER_PR	(1 << 0)	/* All Incoming Frames */
60 #define	GMAC_MAC_HTHIGH		0x08
61 #define	GMAC_MAC_HTLOW		0x0c
62 #define	GMII_ADDRESS		0x10
63 #define	 GMII_ADDRESS_PA_MASK	0x1f		/* Phy device */
64 #define	 GMII_ADDRESS_PA_SHIFT	11
65 #define	 GMII_ADDRESS_GR_MASK	0x1f		/* Phy register */
66 #define	 GMII_ADDRESS_GR_SHIFT	6
67 #define	 GMII_ADDRESS_CR_MASK	0xf
68 #define	 GMII_ADDRESS_CR_SHIFT	2		/* Clock */
69 #define	 GMII_ADDRESS_GW	(1 << 1)	/* Write operation */
70 #define	 GMII_ADDRESS_GB	(1 << 0)	/* Busy */
71 #define	GMII_DATA		0x14
72 #define	FLOW_CONTROL		0x18
73 #define	 FLOW_CONTROL_PT_SHIFT	16
74 #define	 FLOW_CONTROL_UP	(1 << 3)	/* Unicast pause enable */
75 #define	 FLOW_CONTROL_RX	(1 << 2)	/* RX Flow control enable */
76 #define	 FLOW_CONTROL_TX	(1 << 1)	/* TX Flow control enable */
77 #define	GMAC_VLAN_TAG		0x1C
78 #define	VERSION			0x20
79 #define	DEBUG			0x24
80 #define	LPI_CONTROL_STATUS	0x30
81 #define	LPI_TIMERS_CONTROL	0x34
82 #define	INTERRUPT_STATUS	0x38
83 #define	INTERRUPT_MASK		0x3C
84 #define	MAC_ADDRESS_HIGH(n)	((n > 15 ? 0x800 : 0x40) + 0x8 * n)
85 #define	MAC_ADDRESS_LOW(n)	((n > 15 ? 0x804 : 0x44) + 0x8 * n)
86 
87 #define	SGMII_RGMII_SMII_CTRL_STATUS	0xD8
88 #define	MMC_CONTROL			0x100
89 #define	 MMC_CONTROL_CNTRST		(1 << 0)
90 #define	MMC_RECEIVE_INTERRUPT		0x104
91 #define	MMC_TRANSMIT_INTERRUPT		0x108
92 #define	MMC_RECEIVE_INTERRUPT_MASK	0x10C
93 #define	MMC_TRANSMIT_INTERRUPT_MASK	0x110
94 #define	TXOCTETCOUNT_GB			0x114
95 #define	TXFRAMECOUNT_GB			0x118
96 #define	TXBROADCASTFRAMES_G		0x11C
97 #define	TXMULTICASTFRAMES_G		0x120
98 #define	TX64OCTETS_GB			0x124
99 #define	TX65TO127OCTETS_GB		0x128
100 #define	TX128TO255OCTETS_GB		0x12C
101 #define	TX256TO511OCTETS_GB		0x130
102 #define	TX512TO1023OCTETS_GB		0x134
103 #define	TX1024TOMAXOCTETS_GB		0x138
104 #define	TXUNICASTFRAMES_GB		0x13C
105 #define	TXMULTICASTFRAMES_GB		0x140
106 #define	TXBROADCASTFRAMES_GB		0x144
107 #define	TXUNDERFLOWERROR		0x148
108 #define	TXSINGLECOL_G			0x14C
109 #define	TXMULTICOL_G			0x150
110 #define	TXDEFERRED			0x154
111 #define	TXLATECOL			0x158
112 #define	TXEXESSCOL			0x15C
113 #define	TXCARRIERERR			0x160
114 #define	TXOCTETCNT			0x164
115 #define	TXFRAMECOUNT_G			0x168
116 #define	TXEXCESSDEF			0x16C
117 #define	TXPAUSEFRAMES			0x170
118 #define	TXVLANFRAMES_G			0x174
119 #define	TXOVERSIZE_G			0x178
120 #define	RXFRAMECOUNT_GB			0x180
121 #define	RXOCTETCOUNT_GB			0x184
122 #define	RXOCTETCOUNT_G			0x188
123 #define	RXBROADCASTFRAMES_G		0x18C
124 #define	RXMULTICASTFRAMES_G		0x190
125 #define	RXCRCERROR			0x194
126 #define	RXALIGNMENTERROR		0x198
127 #define	RXRUNTERROR			0x19C
128 #define	RXJABBERERROR			0x1A0
129 #define	RXUNDERSIZE_G			0x1A4
130 #define	RXOVERSIZE_G			0x1A8
131 #define	RX64OCTETS_GB			0x1AC
132 #define	RX65TO127OCTETS_GB		0x1B0
133 #define	RX128TO255OCTETS_GB		0x1B4
134 #define	RX256TO511OCTETS_GB		0x1B8
135 #define	RX512TO1023OCTETS_GB		0x1BC
136 #define	RX1024TOMAXOCTETS_GB		0x1C0
137 #define	RXUNICASTFRAMES_G		0x1C4
138 #define	RXLENGTHERROR			0x1C8
139 #define	RXOUTOFRANGETYPE		0x1CC
140 #define	RXPAUSEFRAMES			0x1D0
141 #define	RXFIFOOVERFLOW			0x1D4
142 #define	RXVLANFRAMES_GB			0x1D8
143 #define	RXWATCHDOGERROR			0x1DC
144 #define	RXRCVERROR			0x1E0
145 #define	RXCTRLFRAMES_G			0x1E4
146 #define	MMC_IPC_RECEIVE_INT_MASK	0x200
147 #define	MMC_IPC_RECEIVE_INT		0x208
148 #define	RXIPV4_GD_FRMS			0x210
149 #define	RXIPV4_HDRERR_FRMS		0x214
150 #define	RXIPV4_NOPAY_FRMS		0x218
151 #define	RXIPV4_FRAG_FRMS		0x21C
152 #define	RXIPV4_UDSBL_FRMS		0x220
153 #define	RXIPV6_GD_FRMS			0x224
154 #define	RXIPV6_HDRERR_FRMS		0x228
155 #define	RXIPV6_NOPAY_FRMS		0x22C
156 #define	RXUDP_GD_FRMS			0x230
157 #define	RXUDP_ERR_FRMS			0x234
158 #define	RXTCP_GD_FRMS			0x238
159 #define	RXTCP_ERR_FRMS			0x23C
160 #define	RXICMP_GD_FRMS			0x240
161 #define	RXICMP_ERR_FRMS			0x244
162 #define	RXIPV4_GD_OCTETS		0x250
163 #define	RXIPV4_HDRERR_OCTETS		0x254
164 #define	RXIPV4_NOPAY_OCTETS		0x258
165 #define	RXIPV4_FRAG_OCTETS		0x25C
166 #define	RXIPV4_UDSBL_OCTETS		0x260
167 #define	RXIPV6_GD_OCTETS		0x264
168 #define	RXIPV6_HDRERR_OCTETS		0x268
169 #define	RXIPV6_NOPAY_OCTETS		0x26C
170 #define	RXUDP_GD_OCTETS			0x270
171 #define	RXUDP_ERR_OCTETS		0x274
172 #define	RXTCP_GD_OCTETS			0x278
173 #define	RXTCPERROCTETS			0x27C
174 #define	RXICMP_GD_OCTETS		0x280
175 #define	RXICMP_ERR_OCTETS		0x284
176 #define	L3_L4_CONTROL0			0x400
177 #define	LAYER4_ADDRESS0			0x404
178 #define	LAYER3_ADDR0_REG0		0x410
179 #define	LAYER3_ADDR1_REG0		0x414
180 #define	LAYER3_ADDR2_REG0		0x418
181 #define	LAYER3_ADDR3_REG0		0x41C
182 #define	L3_L4_CONTROL1			0x430
183 #define	LAYER4_ADDRESS1			0x434
184 #define	LAYER3_ADDR0_REG1		0x440
185 #define	LAYER3_ADDR1_REG1		0x444
186 #define	LAYER3_ADDR2_REG1		0x448
187 #define	LAYER3_ADDR3_REG1		0x44C
188 #define	L3_L4_CONTROL2			0x460
189 #define	LAYER4_ADDRESS2			0x464
190 #define	LAYER3_ADDR0_REG2		0x470
191 #define	LAYER3_ADDR1_REG2		0x474
192 #define	LAYER3_ADDR2_REG2		0x478
193 #define	LAYER3_ADDR3_REG2		0x47C
194 #define	L3_L4_CONTROL3			0x490
195 #define	LAYER4_ADDRESS3			0x494
196 #define	LAYER3_ADDR0_REG3		0x4A0
197 #define	LAYER3_ADDR1_REG3		0x4A4
198 #define	LAYER3_ADDR2_REG3		0x4A8
199 #define	LAYER3_ADDR3_REG3		0x4AC
200 #define	HASH_TABLE_REG(n)		0x500 + (0x4 * n)
201 #define	VLAN_INCL_REG			0x584
202 #define	VLAN_HASH_TABLE_REG		0x588
203 #define	TIMESTAMP_CONTROL		0x700
204 #define	SUB_SECOND_INCREMENT		0x704
205 #define	SYSTEM_TIME_SECONDS		0x708
206 #define	SYSTEM_TIME_NANOSECONDS		0x70C
207 #define	SYSTEM_TIME_SECONDS_UPDATE	0x710
208 #define	SYSTEM_TIME_NANOSECONDS_UPDATE	0x714
209 #define	TIMESTAMP_ADDEND		0x718
210 #define	TARGET_TIME_SECONDS		0x71C
211 #define	TARGET_TIME_NANOSECONDS		0x720
212 #define	SYSTEM_TIME_HIGHER_WORD_SECONDS	0x724
213 #define	TIMESTAMP_STATUS		0x728
214 #define	PPS_CONTROL			0x72C
215 #define	AUXILIARY_TIMESTAMP_NANOSECONDS	0x730
216 #define	AUXILIARY_TIMESTAMP_SECONDS	0x734
217 #define	PPS0_INTERVAL			0x760
218 #define	PPS0_WIDTH			0x764
219 
220 /* DMA */
221 #define	BUS_MODE		0x1000
222 #define	 BUS_MODE_EIGHTXPBL	(1 << 24) /* Multiplies PBL by 8 */
223 #define	 BUS_MODE_USP		(1 << 23)
224 #define	 BUS_MODE_RPBL_SHIFT	17 /* Single block transfer size */
225 #define	 BUS_MODE_FIXEDBURST	(1 << 16)
226 #define	 BUS_MODE_PRIORXTX_SHIFT	14
227 #define	 BUS_MODE_PRIORXTX_41	3
228 #define	 BUS_MODE_PRIORXTX_31	2
229 #define	 BUS_MODE_PRIORXTX_21	1
230 #define	 BUS_MODE_PRIORXTX_11	0
231 #define	 BUS_MODE_PBL_SHIFT	8 /* Single block transfer size */
232 #define	 BUS_MODE_SWR		(1 << 0) /* Reset */
233 #define	 BUS_MODE_DEFAULT_PBL	8
234 #define	TRANSMIT_POLL_DEMAND	0x1004
235 #define	RECEIVE_POLL_DEMAND	0x1008
236 #define	RX_DESCR_LIST_ADDR	0x100C
237 #define	TX_DESCR_LIST_ADDR	0x1010
238 #define	DMA_STATUS		0x1014
239 #define	 DMA_STATUS_NIS		(1 << 16)
240 #define	 DMA_STATUS_AIS		(1 << 15)
241 #define	 DMA_STATUS_FBI		(1 << 13)
242 #define	 DMA_STATUS_RI		(1 << 6)
243 #define	 DMA_STATUS_TI		(1 << 0)
244 #define	 DMA_STATUS_INTR_MASK	0x1ffff
245 #define	OPERATION_MODE		0x1018
246 #define	 MODE_RSF		(1 << 25) /* RX Full Frame */
247 #define	 MODE_TSF		(1 << 21) /* TX Full Frame */
248 #define	 MODE_FTF		(1 << 20) /* Flush TX FIFO */
249 #define	 MODE_ST		(1 << 13) /* Start DMA TX */
250 #define	 MODE_FUF		(1 << 6)  /* TX frames < 64bytes */
251 #define	 MODE_RTC_LEV32		0x1
252 #define	 MODE_RTC_SHIFT		3
253 #define	 MODE_OSF		(1 << 2) /* Process Second frame */
254 #define	 MODE_SR		(1 << 1) /* Start DMA RX */
255 #define	INTERRUPT_ENABLE	0x101C
256 #define	 INT_EN_NIE		(1 << 16) /* Normal/Summary */
257 #define	 INT_EN_AIE		(1 << 15) /* Abnormal/Summary */
258 #define	 INT_EN_ERE		(1 << 14) /* Early receive */
259 #define	 INT_EN_FBE		(1 << 13) /* Fatal bus error */
260 #define	 INT_EN_ETE		(1 << 10) /* Early transmit */
261 #define	 INT_EN_RWE		(1 << 9)  /* Receive watchdog */
262 #define	 INT_EN_RSE		(1 << 8)  /* Receive stopped */
263 #define	 INT_EN_RUE		(1 << 7)  /* Recv buf unavailable */
264 #define	 INT_EN_RIE		(1 << 6)  /* Receive interrupt */
265 #define	 INT_EN_UNE		(1 << 5)  /* Tx underflow */
266 #define	 INT_EN_OVE		(1 << 4)  /* Receive overflow */
267 #define	 INT_EN_TJE		(1 << 3)  /* Transmit jabber */
268 #define	 INT_EN_TUE		(1 << 2)  /* Tx. buf unavailable */
269 #define	 INT_EN_TSE		(1 << 1)  /* Transmit stopped */
270 #define	 INT_EN_TIE		(1 << 0)  /* Transmit interrupt */
271 #define	 INT_EN_DEFAULT		(INT_EN_TIE|INT_EN_RIE|	\
272 	    INT_EN_NIE|INT_EN_AIE|			\
273 	    INT_EN_FBE|INT_EN_UNE)
274 
275 #define	MISSED_FRAMEBUF_OVERFLOW_CNTR	0x1020
276 #define	RECEIVE_INT_WATCHDOG_TMR	0x1024
277 #define	AXI_BUS_MODE			0x1028
278 #define	AHB_OR_AXI_STATUS		0x102C
279 #define	CURRENT_HOST_TRANSMIT_DESCR	0x1048
280 #define	CURRENT_HOST_RECEIVE_DESCR	0x104C
281 #define	CURRENT_HOST_TRANSMIT_BUF_ADDR	0x1050
282 #define	CURRENT_HOST_RECEIVE_BUF_ADDR	0x1054
283 #define	HW_FEATURE			0x1058
284 
285 #define	DWC_GMAC_NORMAL_DESC		0x1
286 #define	DWC_GMAC_EXT_DESC		0x2
287 
288 #define	GMAC_MII_CLK_60_100M_DIV42	0x0
289 #define	GMAC_MII_CLK_100_150M_DIV62	0x1
290 #define	GMAC_MII_CLK_25_35M_DIV16	0x2
291 #define	GMAC_MII_CLK_35_60M_DIV26	0x3
292 #define	GMAC_MII_CLK_150_250M_DIV102	0x4
293 #define	GMAC_MII_CLK_250_300M_DIV124	0x5
294 #define	GMAC_MII_CLK_DIV4		0x8
295 #define	GMAC_MII_CLK_DIV6		0x9
296 #define	GMAC_MII_CLK_DIV8		0xa
297 #define	GMAC_MII_CLK_DIV10		0xb
298 #define	GMAC_MII_CLK_DIV12		0xc
299 #define	GMAC_MII_CLK_DIV14		0xd
300 #define	GMAC_MII_CLK_DIV16		0xe
301 #define	GMAC_MII_CLK_DIV18		0xf
302 
303 #endif	/* __IF_DWC_H__ */
304