xref: /openbmc/u-boot/drivers/net/ftgmac100.h (revision e87eb2705bcb5850b6af8ca79d3ba1d6a51f0a26)
1  /* SPDX-License-Identifier: GPL-2.0+ */
2  /*
3   * Faraday FTGMAC100 Ethernet
4   *
5   * (C) Copyright 2010 Faraday Technology
6   * Po-Yu Chuang <ratbert@faraday-tech.com>
7   *
8   * (C) Copyright 2010 Andes Technology
9   * Macpaul Lin <macpaul@andestech.com>
10   */
11  
12  #ifndef __FTGMAC100_H
13  #define __FTGMAC100_H
14  
15  /* The registers offset table of ftgmac100 */
16  struct ftgmac100 {
17  	unsigned int	isr;		/* 0x00 */
18  	unsigned int	ier;		/* 0x04 */
19  	unsigned int	mac_madr;	/* 0x08 */
20  	unsigned int	mac_ladr;	/* 0x0c */
21  	unsigned int	maht0;		/* 0x10 */
22  	unsigned int	maht1;		/* 0x14 */
23  	unsigned int	txpd;		/* 0x18 */
24  	unsigned int	rxpd;		/* 0x1c */
25  	unsigned int	txr_badr;	/* 0x20 */
26  	unsigned int	rxr_badr;	/* 0x24 */
27  	unsigned int	hptxpd;		/* 0x28 */
28  	unsigned int	hptxpd_badr;	/* 0x2c */
29  	unsigned int	itc;		/* 0x30 */
30  	unsigned int	aptc;		/* 0x34 */
31  	unsigned int	dblac;		/* 0x38 */
32  	unsigned int	dmafifos;	/* 0x3c */
33  	unsigned int	revr;		/* 0x40 */
34  	unsigned int	fear;		/* 0x44 */
35  	unsigned int	tpafcr;		/* 0x48 */
36  	unsigned int	rbsr;		/* 0x4c */
37  	unsigned int	maccr;		/* 0x50 */
38  	unsigned int	macsr;		/* 0x54 */
39  	unsigned int	tm;		/* 0x58 */
40  	unsigned int	resv1;		/* 0x5c */ /* not defined in spec */
41  	unsigned int	phycr;		/* 0x60 */
42  	unsigned int	phydata;	/* 0x64 */
43  	unsigned int	fcr;		/* 0x68 */
44  	unsigned int	bpr;		/* 0x6c */
45  	unsigned int	wolcr;		/* 0x70 */
46  	unsigned int	wolsr;		/* 0x74 */
47  	unsigned int	wfcrc;		/* 0x78 */
48  	unsigned int	resv2;		/* 0x7c */ /* not defined in spec */
49  	unsigned int	wfbm1;		/* 0x80 */
50  	unsigned int	wfbm2;		/* 0x84 */
51  	unsigned int	wfbm3;		/* 0x88 */
52  	unsigned int	wfbm4;		/* 0x8c */
53  	unsigned int	nptxr_ptr;	/* 0x90 */
54  	unsigned int	hptxr_ptr;	/* 0x94 */
55  	unsigned int	rxr_ptr;	/* 0x98 */
56  	unsigned int	resv3;		/* 0x9c */ /* not defined in spec */
57  	unsigned int	tx;		/* 0xa0 */
58  	unsigned int	tx_mcol_scol;	/* 0xa4 */
59  	unsigned int	tx_ecol_fail;	/* 0xa8 */
60  	unsigned int	tx_lcol_und;	/* 0xac */
61  	unsigned int	rx;		/* 0xb0 */
62  	unsigned int	rx_bc;		/* 0xb4 */
63  	unsigned int	rx_mc;		/* 0xb8 */
64  	unsigned int	rx_pf_aep;	/* 0xbc */
65  	unsigned int	rx_runt;	/* 0xc0 */
66  	unsigned int	rx_crcer_ftl;	/* 0xc4 */
67  	unsigned int	rx_col_lost;	/* 0xc8 */
68  };
69  
70  /*
71   * Interrupt status register & interrupt enable register
72   */
73  #define FTGMAC100_INT_RPKT_BUF		BIT(0)
74  #define FTGMAC100_INT_RPKT_FIFO		BIT(1)
75  #define FTGMAC100_INT_NO_RXBUF		BIT(2)
76  #define FTGMAC100_INT_RPKT_LOST		BIT(3)
77  #define FTGMAC100_INT_XPKT_ETH		BIT(4)
78  #define FTGMAC100_INT_XPKT_FIFO		BIT(5)
79  #define FTGMAC100_INT_NO_NPTXBUF	BIT(6)
80  #define FTGMAC100_INT_XPKT_LOST		BIT(7)
81  #define FTGMAC100_INT_AHB_ERR		BIT(8)
82  #define FTGMAC100_INT_PHYSTS_CHG	BIT(9)
83  #define FTGMAC100_INT_NO_HPTXBUF	BIT(10)
84  
85  /*
86   * Interrupt timer control register
87   */
88  #define FTGMAC100_ITC_RXINT_CNT(x)	(((x) & 0xf) << 0)
89  #define FTGMAC100_ITC_RXINT_THR(x)	(((x) & 0x7) << 4)
90  #define FTGMAC100_ITC_RXINT_TIME_SEL	BIT(7)
91  #define FTGMAC100_ITC_TXINT_CNT(x)	(((x) & 0xf) << 8)
92  #define FTGMAC100_ITC_TXINT_THR(x)	(((x) & 0x7) << 12)
93  #define FTGMAC100_ITC_TXINT_TIME_SEL	BIT(15)
94  
95  /*
96   * Automatic polling timer control register
97   */
98  #define FTGMAC100_APTC_RXPOLL_CNT(x)	(((x) & 0xf) << 0)
99  #define FTGMAC100_APTC_RXPOLL_TIME_SEL	BIT(4)
100  #define FTGMAC100_APTC_TXPOLL_CNT(x)	(((x) & 0xf) << 8)
101  #define FTGMAC100_APTC_TXPOLL_TIME_SEL	BIT(12)
102  
103  /*
104   * DMA burst length and arbitration control register
105   */
106  #define FTGMAC100_DBLAC_RXFIFO_LTHR(x)	(((x) & 0x7) << 0)
107  #define FTGMAC100_DBLAC_RXFIFO_HTHR(x)	(((x) & 0x7) << 3)
108  #define FTGMAC100_DBLAC_RX_THR_EN	BIT(6)
109  #define FTGMAC100_DBLAC_RXBURST_SIZE(x)	(((x) & 0x3) << 8)
110  #define FTGMAC100_DBLAC_TXBURST_SIZE(x)	(((x) & 0x3) << 10)
111  #define FTGMAC100_DBLAC_RXDES_SIZE(x)	(((x) & 0xf) << 12)
112  #define FTGMAC100_DBLAC_TXDES_SIZE(x)	(((x) & 0xf) << 16)
113  #define FTGMAC100_DBLAC_IFG_CNT(x)	(((x) & 0x7) << 20)
114  #define FTGMAC100_DBLAC_IFG_INC		BIT(23)
115  
116  /*
117   * DMA FIFO status register
118   */
119  #define FTGMAC100_DMAFIFOS_RXDMA1_SM(dmafifos)	((dmafifos) & 0xf)
120  #define FTGMAC100_DMAFIFOS_RXDMA2_SM(dmafifos)	(((dmafifos) >> 4) & 0xf)
121  #define FTGMAC100_DMAFIFOS_RXDMA3_SM(dmafifos)	(((dmafifos) >> 8) & 0x7)
122  #define FTGMAC100_DMAFIFOS_TXDMA1_SM(dmafifos)	(((dmafifos) >> 12) & 0xf)
123  #define FTGMAC100_DMAFIFOS_TXDMA2_SM(dmafifos)	(((dmafifos) >> 16) & 0x3)
124  #define FTGMAC100_DMAFIFOS_TXDMA3_SM(dmafifos)	(((dmafifos) >> 18) & 0xf)
125  #define FTGMAC100_DMAFIFOS_RXFIFO_EMPTY		BIT(26)
126  #define FTGMAC100_DMAFIFOS_TXFIFO_EMPTY		BIT(27)
127  #define FTGMAC100_DMAFIFOS_RXDMA_GRANT		BIT(28)
128  #define FTGMAC100_DMAFIFOS_TXDMA_GRANT		BIT(29)
129  #define FTGMAC100_DMAFIFOS_RXDMA_REQ		BIT(30)
130  #define FTGMAC100_DMAFIFOS_TXDMA_REQ		BIT(31)
131  
132  /*
133   * Receive buffer size register
134   */
135  #define FTGMAC100_RBSR_SIZE(x)		((x) & 0x3fff)
136  
137  /*
138   * MAC control register
139   */
140  #define FTGMAC100_MACCR_TXDMA_EN	BIT(0)
141  #define FTGMAC100_MACCR_RXDMA_EN	BIT(1)
142  #define FTGMAC100_MACCR_TXMAC_EN	BIT(2)
143  #define FTGMAC100_MACCR_RXMAC_EN	BIT(3)
144  #define FTGMAC100_MACCR_RM_VLAN		BIT(4)
145  #define FTGMAC100_MACCR_HPTXR_EN	BIT(5)
146  #define FTGMAC100_MACCR_LOOP_EN		BIT(6)
147  #define FTGMAC100_MACCR_ENRX_IN_HALFTX	BIT(7)
148  #define FTGMAC100_MACCR_FULLDUP		BIT(8)
149  #define FTGMAC100_MACCR_GIGA_MODE	BIT(9)
150  #define FTGMAC100_MACCR_CRC_APD		BIT(10)
151  #define FTGMAC100_MACCR_RX_RUNT		BIT(12)
152  #define FTGMAC100_MACCR_JUMBO_LF	BIT(13)
153  #define FTGMAC100_MACCR_RX_ALL		BIT(14)
154  #define FTGMAC100_MACCR_HT_MULTI_EN	BIT(15)
155  #define FTGMAC100_MACCR_RX_MULTIPKT	BIT(16)
156  #define FTGMAC100_MACCR_RX_BROADPKT	BIT(17)
157  #define FTGMAC100_MACCR_DISCARD_CRCERR	BIT(18)
158  #define FTGMAC100_MACCR_FAST_MODE	BIT(19)
159  #define FTGMAC100_MACCR_SW_RST		BIT(31)
160  
161  /*
162   * PHY control register
163   */
164  #define FTGMAC100_PHYCR_MDC_CYCTHR_MASK	0x3f
165  #define FTGMAC100_PHYCR_MDC_CYCTHR(x)	((x) & 0x3f)
166  #define FTGMAC100_PHYCR_PHYAD(x)	(((x) & 0x1f) << 16)
167  #define FTGMAC100_PHYCR_REGAD(x)	(((x) & 0x1f) << 21)
168  #define FTGMAC100_PHYCR_MIIRD		BIT(26)
169  #define FTGMAC100_PHYCR_MIIWR		BIT(27)
170  
171  /*
172   * PHY data register
173   */
174  #define FTGMAC100_PHYDATA_MIIWDATA(x)		((x) & 0xffff)
175  #define FTGMAC100_PHYDATA_MIIRDATA(phydata)	(((phydata) >> 16) & 0xffff)
176  
177  /*
178   * Transmit descriptor, aligned to 16 bytes
179   */
180  
181  #ifndef CONFIG_SYS_DCACHE_OFF
182  struct ftgmac100_txdes {
183  	unsigned int	txdes0;
184  	unsigned int	txdes1;
185  	unsigned int	txdes2;	/* not used by HW */
186  	unsigned int	txdes3;	/* TXBUF_BADR */
187  } __aligned(CONFIG_SYS_CACHELINE_SIZE);
188  #else
189  struct ftgmac100_txdes {
190  	unsigned int	txdes0;
191  	unsigned int	txdes1;
192  	unsigned int	txdes2;	/* not used by HW */
193  	unsigned int	txdes3;	/* TXBUF_BADR */
194  } __aligned(16);
195  #endif
196  
197  #define FTGMAC100_TXDES0_TXBUF_SIZE(x)	((x) & 0x3fff)
198  #define FTGMAC100_TXDES0_EDOTR		BIT(15)
199  #define FTGMAC100_TXDES0_CRC_ERR	BIT(19)
200  #define FTGMAC100_TXDES0_LTS		BIT(28)
201  #define FTGMAC100_TXDES0_FTS		BIT(29)
202  #define FTGMAC100_TXDES0_TXDMA_OWN	BIT(31)
203  
204  #define FTGMAC100_TXDES1_VLANTAG_CI(x)	((x) & 0xffff)
205  #define FTGMAC100_TXDES1_INS_VLANTAG	BIT(16)
206  #define FTGMAC100_TXDES1_TCP_CHKSUM	BIT(17)
207  #define FTGMAC100_TXDES1_UDP_CHKSUM	BIT(18)
208  #define FTGMAC100_TXDES1_IP_CHKSUM	BIT(19)
209  #define FTGMAC100_TXDES1_LLC		BIT(22)
210  #define FTGMAC100_TXDES1_TX2FIC		BIT(30)
211  #define FTGMAC100_TXDES1_TXIC		BIT(31)
212  
213  /*
214   * Receive descriptor, aligned to 16 bytes
215   */
216  #ifndef CONFIG_SYS_DCACHE_OFF
217  struct ftgmac100_rxdes {
218  	unsigned int	rxdes0;
219  	unsigned int	rxdes1;
220  	unsigned int	rxdes2;	/* not used by HW */
221  	unsigned int	rxdes3;	/* RXBUF_BADR */
222  } __aligned(CONFIG_SYS_CACHELINE_SIZE);
223  #else
224  struct ftgmac100_rxdes {
225  	unsigned int	rxdes0;
226  	unsigned int	rxdes1;
227  	unsigned int	rxdes2;	/* not used by HW */
228  	unsigned int	rxdes3;	/* RXBUF_BADR */
229  } __aligned(16);
230  #endif
231  
232  #define FTGMAC100_RXDES0_VDBC(x)	((x) & 0x3fff)
233  #define FTGMAC100_RXDES0_EDORR		BIT(15)
234  #define FTGMAC100_RXDES0_MULTICAST	BIT(16)
235  #define FTGMAC100_RXDES0_BROADCAST	BIT(17)
236  #define FTGMAC100_RXDES0_RX_ERR		BIT(18)
237  #define FTGMAC100_RXDES0_CRC_ERR	BIT(19)
238  #define FTGMAC100_RXDES0_FTL		BIT(20)
239  #define FTGMAC100_RXDES0_RUNT		BIT(21)
240  #define FTGMAC100_RXDES0_RX_ODD_NB	BIT(22)
241  #define FTGMAC100_RXDES0_FIFO_FULL	BIT(23)
242  #define FTGMAC100_RXDES0_PAUSE_OPCODE	BIT(24)
243  #define FTGMAC100_RXDES0_PAUSE_FRAME	BIT(25)
244  #define FTGMAC100_RXDES0_LRS		BIT(28)
245  #define FTGMAC100_RXDES0_FRS		BIT(29)
246  #define FTGMAC100_RXDES0_RXPKT_RDY	BIT(31)
247  
248  #define FTGMAC100_RXDES1_VLANTAG_CI	0xffff
249  #define FTGMAC100_RXDES1_PROT_MASK	(0x3 << 20)
250  #define FTGMAC100_RXDES1_PROT_NONIP	(0x0 << 20)
251  #define FTGMAC100_RXDES1_PROT_IP	(0x1 << 20)
252  #define FTGMAC100_RXDES1_PROT_TCPIP	(0x2 << 20)
253  #define FTGMAC100_RXDES1_PROT_UDPIP	(0x3 << 20)
254  #define FTGMAC100_RXDES1_LLC		BIT(22)
255  #define FTGMAC100_RXDES1_DF		BIT(23)
256  #define FTGMAC100_RXDES1_VLANTAG_AVAIL	BIT(24)
257  #define FTGMAC100_RXDES1_TCP_CHKSUM_ERR	BIT(25)
258  #define FTGMAC100_RXDES1_UDP_CHKSUM_ERR	BIT(26)
259  #define FTGMAC100_RXDES1_IP_CHKSUM_ERR	BIT(27)
260  
261  #endif /* __FTGMAC100_H */
262