xref: /openbmc/u-boot/include/tsec.h (revision fea7f3aa)
1 /*
2  *  tsec.h
3  *
4  *  Driver for the Motorola Triple Speed Ethernet Controller
5  *
6  *  This software may be used and distributed according to the
7  *  terms of the GNU Public License, Version 2, incorporated
8  *  herein by reference.
9  *
10  * Copyright 2004, 2007, 2009, 2011, 2013 Freescale Semiconductor, Inc.
11  * (C) Copyright 2003, Motorola, Inc.
12  * maintained by Xianghua Xiao (x.xiao@motorola.com)
13  * author Andy Fleming
14  *
15  */
16 
17 #ifndef __TSEC_H
18 #define __TSEC_H
19 
20 #include <net.h>
21 #include <config.h>
22 #include <phy.h>
23 
24 #ifdef CONFIG_LS102XA
25 #define TSEC_SIZE		0x40000
26 #define TSEC_MDIO_OFFSET	0x40000
27 #else
28 #define TSEC_SIZE 		0x01000
29 #define TSEC_MDIO_OFFSET	0x01000
30 #endif
31 
32 #define CONFIG_SYS_MDIO_BASE_ADDR (MDIO_BASE_ADDR + 0x520)
33 
34 #define TSEC_GET_REGS(num, offset) \
35 	(struct tsec __iomem *)\
36 	(TSEC_BASE_ADDR + (((num) - 1) * (offset)))
37 
38 #define TSEC_GET_REGS_BASE(num) \
39 	TSEC_GET_REGS((num), TSEC_SIZE)
40 
41 #define TSEC_GET_MDIO_REGS(num, offset) \
42 	(struct tsec_mii_mng __iomem *)\
43 	(CONFIG_SYS_MDIO_BASE_ADDR  + ((num) - 1) * (offset))
44 
45 #define TSEC_GET_MDIO_REGS_BASE(num) \
46 	TSEC_GET_MDIO_REGS((num), TSEC_MDIO_OFFSET)
47 
48 #define DEFAULT_MII_NAME "FSL_MDIO"
49 
50 #define STD_TSEC_INFO(num) \
51 {			\
52 	.regs = TSEC_GET_REGS_BASE(num), \
53 	.miiregs_sgmii = TSEC_GET_MDIO_REGS_BASE(num), \
54 	.devname = CONFIG_TSEC##num##_NAME, \
55 	.phyaddr = TSEC##num##_PHY_ADDR, \
56 	.flags = TSEC##num##_FLAGS, \
57 	.mii_devname = DEFAULT_MII_NAME \
58 }
59 
60 #define SET_STD_TSEC_INFO(x, num) \
61 {			\
62 	x.regs = TSEC_GET_REGS_BASE(num); \
63 	x.miiregs_sgmii = TSEC_GET_MDIO_REGS_BASE(num); \
64 	x.devname = CONFIG_TSEC##num##_NAME; \
65 	x.phyaddr = TSEC##num##_PHY_ADDR; \
66 	x.flags = TSEC##num##_FLAGS;\
67 	x.mii_devname = DEFAULT_MII_NAME;\
68 }
69 
70 #define MAC_ADDR_LEN 6
71 
72 /* #define TSEC_TIMEOUT	1000000 */
73 #define TSEC_TIMEOUT 1000
74 #define TOUT_LOOP	1000000
75 
76 /* TBI register addresses */
77 #define TBI_CR			0x00
78 #define TBI_SR			0x01
79 #define TBI_ANA			0x04
80 #define TBI_ANLPBPA		0x05
81 #define TBI_ANEX		0x06
82 #define TBI_TBICON		0x11
83 
84 /* TBI MDIO register bit fields*/
85 #define TBICON_CLK_SELECT	0x0020
86 #define TBIANA_ASYMMETRIC_PAUSE 0x0100
87 #define TBIANA_SYMMETRIC_PAUSE  0x0080
88 #define TBIANA_HALF_DUPLEX	0x0040
89 #define TBIANA_FULL_DUPLEX	0x0020
90 #define TBICR_PHY_RESET		0x8000
91 #define TBICR_ANEG_ENABLE	0x1000
92 #define TBICR_RESTART_ANEG	0x0200
93 #define TBICR_FULL_DUPLEX	0x0100
94 #define TBICR_SPEED1_SET	0x0040
95 
96 
97 /* MAC register bits */
98 #define MACCFG1_SOFT_RESET	0x80000000
99 #define MACCFG1_RESET_RX_MC	0x00080000
100 #define MACCFG1_RESET_TX_MC	0x00040000
101 #define MACCFG1_RESET_RX_FUN	0x00020000
102 #define	MACCFG1_RESET_TX_FUN	0x00010000
103 #define MACCFG1_LOOPBACK	0x00000100
104 #define MACCFG1_RX_FLOW		0x00000020
105 #define MACCFG1_TX_FLOW		0x00000010
106 #define MACCFG1_SYNCD_RX_EN	0x00000008
107 #define MACCFG1_RX_EN		0x00000004
108 #define MACCFG1_SYNCD_TX_EN	0x00000002
109 #define MACCFG1_TX_EN		0x00000001
110 
111 #define MACCFG2_INIT_SETTINGS	0x00007205
112 #define MACCFG2_FULL_DUPLEX	0x00000001
113 #define MACCFG2_IF		0x00000300
114 #define MACCFG2_GMII		0x00000200
115 #define MACCFG2_MII		0x00000100
116 
117 #define ECNTRL_INIT_SETTINGS	0x00001000
118 #define ECNTRL_TBI_MODE		0x00000020
119 #define ECNTRL_REDUCED_MODE	0x00000010
120 #define ECNTRL_R100		0x00000008
121 #define ECNTRL_REDUCED_MII_MODE	0x00000004
122 #define ECNTRL_SGMII_MODE	0x00000002
123 
124 #ifndef CONFIG_SYS_TBIPA_VALUE
125     #define CONFIG_SYS_TBIPA_VALUE	0x1f
126 #endif
127 
128 #define MRBLR_INIT_SETTINGS	PKTSIZE_ALIGN
129 
130 #define MINFLR_INIT_SETTINGS	0x00000040
131 
132 #define DMACTRL_INIT_SETTINGS	0x000000c3
133 #define DMACTRL_GRS		0x00000010
134 #define DMACTRL_GTS		0x00000008
135 #define DMACTRL_LE		0x00008000
136 
137 #define TSTAT_CLEAR_THALT	0x80000000
138 #define RSTAT_CLEAR_RHALT	0x00800000
139 
140 
141 #define IEVENT_INIT_CLEAR	0xffffffff
142 #define IEVENT_BABR		0x80000000
143 #define IEVENT_RXC		0x40000000
144 #define IEVENT_BSY		0x20000000
145 #define IEVENT_EBERR		0x10000000
146 #define IEVENT_MSRO		0x04000000
147 #define IEVENT_GTSC		0x02000000
148 #define IEVENT_BABT		0x01000000
149 #define IEVENT_TXC		0x00800000
150 #define IEVENT_TXE		0x00400000
151 #define IEVENT_TXB		0x00200000
152 #define IEVENT_TXF		0x00100000
153 #define IEVENT_IE		0x00080000
154 #define IEVENT_LC		0x00040000
155 #define IEVENT_CRL		0x00020000
156 #define IEVENT_XFUN		0x00010000
157 #define IEVENT_RXB0		0x00008000
158 #define IEVENT_GRSC		0x00000100
159 #define IEVENT_RXF0		0x00000080
160 
161 #define IMASK_INIT_CLEAR	0x00000000
162 #define IMASK_TXEEN		0x00400000
163 #define IMASK_TXBEN		0x00200000
164 #define IMASK_TXFEN		0x00100000
165 #define IMASK_RXFEN0		0x00000080
166 
167 
168 /* Default Attribute fields */
169 #define ATTR_INIT_SETTINGS     0x000000c0
170 #define ATTRELI_INIT_SETTINGS  0x00000000
171 
172 
173 /* TxBD status field bits */
174 #define TXBD_READY		0x8000
175 #define TXBD_PADCRC		0x4000
176 #define TXBD_WRAP		0x2000
177 #define TXBD_INTERRUPT		0x1000
178 #define TXBD_LAST		0x0800
179 #define TXBD_CRC		0x0400
180 #define TXBD_DEF		0x0200
181 #define TXBD_HUGEFRAME		0x0080
182 #define TXBD_LATECOLLISION	0x0080
183 #define TXBD_RETRYLIMIT		0x0040
184 #define	TXBD_RETRYCOUNTMASK	0x003c
185 #define TXBD_UNDERRUN		0x0002
186 #define TXBD_STATS		0x03ff
187 
188 /* RxBD status field bits */
189 #define RXBD_EMPTY		0x8000
190 #define RXBD_RO1		0x4000
191 #define RXBD_WRAP		0x2000
192 #define RXBD_INTERRUPT		0x1000
193 #define RXBD_LAST		0x0800
194 #define RXBD_FIRST		0x0400
195 #define RXBD_MISS		0x0100
196 #define RXBD_BROADCAST		0x0080
197 #define RXBD_MULTICAST		0x0040
198 #define RXBD_LARGE		0x0020
199 #define RXBD_NONOCTET		0x0010
200 #define RXBD_SHORT		0x0008
201 #define RXBD_CRCERR		0x0004
202 #define RXBD_OVERRUN		0x0002
203 #define RXBD_TRUNCATED		0x0001
204 #define RXBD_STATS		0x003f
205 
206 struct txbd8 {
207 	uint16_t     status;	     /* Status Fields */
208 	uint16_t     length;	     /* Buffer length */
209 	uint32_t     bufptr;	     /* Buffer Pointer */
210 };
211 
212 struct rxbd8 {
213 	uint16_t     status;	     /* Status Fields */
214 	uint16_t     length;	     /* Buffer Length */
215 	uint32_t     bufptr;	     /* Buffer Pointer */
216 };
217 
218 struct tsec_rmon_mib {
219 	/* Transmit and Receive Counters */
220 	u32	tr64;		/* Tx/Rx 64-byte Frame Counter */
221 	u32	tr127;		/* Tx/Rx 65-127 byte Frame Counter */
222 	u32	tr255;		/* Tx/Rx 128-255 byte Frame Counter */
223 	u32	tr511;		/* Tx/Rx 256-511 byte Frame Counter */
224 	u32	tr1k;		/* Tx/Rx 512-1023 byte Frame Counter */
225 	u32	trmax;		/* Tx/Rx 1024-1518 byte Frame Counter */
226 	u32	trmgv;		/* Tx/Rx 1519-1522 byte Good VLAN Frame */
227 	/* Receive Counters */
228 	u32	rbyt;		/* Receive Byte Counter */
229 	u32	rpkt;		/* Receive Packet Counter */
230 	u32	rfcs;		/* Receive FCS Error Counter */
231 	u32	rmca;		/* Receive Multicast Packet (Counter) */
232 	u32	rbca;		/* Receive Broadcast Packet */
233 	u32	rxcf;		/* Receive Control Frame Packet */
234 	u32	rxpf;		/* Receive Pause Frame Packet */
235 	u32	rxuo;		/* Receive Unknown OP Code */
236 	u32	raln;		/* Receive Alignment Error */
237 	u32	rflr;		/* Receive Frame Length Error */
238 	u32	rcde;		/* Receive Code Error */
239 	u32	rcse;		/* Receive Carrier Sense Error */
240 	u32	rund;		/* Receive Undersize Packet */
241 	u32	rovr;		/* Receive Oversize Packet */
242 	u32	rfrg;		/* Receive Fragments */
243 	u32	rjbr;		/* Receive Jabber */
244 	u32	rdrp;		/* Receive Drop */
245 	/* Transmit Counters */
246 	u32	tbyt;		/* Transmit Byte Counter */
247 	u32	tpkt;		/* Transmit Packet */
248 	u32	tmca;		/* Transmit Multicast Packet */
249 	u32	tbca;		/* Transmit Broadcast Packet */
250 	u32	txpf;		/* Transmit Pause Control Frame */
251 	u32	tdfr;		/* Transmit Deferral Packet */
252 	u32	tedf;		/* Transmit Excessive Deferral Packet */
253 	u32	tscl;		/* Transmit Single Collision Packet */
254 	/* (0x2_n700) */
255 	u32	tmcl;		/* Transmit Multiple Collision Packet */
256 	u32	tlcl;		/* Transmit Late Collision Packet */
257 	u32	txcl;		/* Transmit Excessive Collision Packet */
258 	u32	tncl;		/* Transmit Total Collision */
259 
260 	u32	res2;
261 
262 	u32	tdrp;		/* Transmit Drop Frame */
263 	u32	tjbr;		/* Transmit Jabber Frame */
264 	u32	tfcs;		/* Transmit FCS Error */
265 	u32	txcf;		/* Transmit Control Frame */
266 	u32	tovr;		/* Transmit Oversize Frame */
267 	u32	tund;		/* Transmit Undersize Frame */
268 	u32	tfrg;		/* Transmit Fragments Frame */
269 	/* General Registers */
270 	u32	car1;		/* Carry Register One */
271 	u32	car2;		/* Carry Register Two */
272 	u32	cam1;		/* Carry Register One Mask */
273 	u32	cam2;		/* Carry Register Two Mask */
274 };
275 
276 struct tsec_hash_regs {
277 	u32	iaddr0;		/* Individual Address Register 0 */
278 	u32	iaddr1;		/* Individual Address Register 1 */
279 	u32	iaddr2;		/* Individual Address Register 2 */
280 	u32	iaddr3;		/* Individual Address Register 3 */
281 	u32	iaddr4;		/* Individual Address Register 4 */
282 	u32	iaddr5;		/* Individual Address Register 5 */
283 	u32	iaddr6;		/* Individual Address Register 6 */
284 	u32	iaddr7;		/* Individual Address Register 7 */
285 	u32	res1[24];
286 	u32	gaddr0;		/* Group Address Register 0 */
287 	u32	gaddr1;		/* Group Address Register 1 */
288 	u32	gaddr2;		/* Group Address Register 2 */
289 	u32	gaddr3;		/* Group Address Register 3 */
290 	u32	gaddr4;		/* Group Address Register 4 */
291 	u32	gaddr5;		/* Group Address Register 5 */
292 	u32	gaddr6;		/* Group Address Register 6 */
293 	u32	gaddr7;		/* Group Address Register 7 */
294 	u32	res2[24];
295 };
296 
297 struct tsec {
298 	/* General Control and Status Registers (0x2_n000) */
299 	u32	res000[4];
300 
301 	u32	ievent;		/* Interrupt Event */
302 	u32	imask;		/* Interrupt Mask */
303 	u32	edis;		/* Error Disabled */
304 	u32	res01c;
305 	u32	ecntrl;		/* Ethernet Control */
306 	u32	minflr;		/* Minimum Frame Length */
307 	u32	ptv;		/* Pause Time Value */
308 	u32	dmactrl;	/* DMA Control */
309 	u32	tbipa;		/* TBI PHY Address */
310 
311 	u32	res034[3];
312 	u32	res040[48];
313 
314 	/* Transmit Control and Status Registers (0x2_n100) */
315 	u32	tctrl;		/* Transmit Control */
316 	u32	tstat;		/* Transmit Status */
317 	u32	res108;
318 	u32	tbdlen;		/* Tx BD Data Length */
319 	u32	res110[5];
320 	u32	ctbptr;		/* Current TxBD Pointer */
321 	u32	res128[23];
322 	u32	tbptr;		/* TxBD Pointer */
323 	u32	res188[30];
324 	/* (0x2_n200) */
325 	u32	res200;
326 	u32	tbase;		/* TxBD Base Address */
327 	u32	res208[42];
328 	u32	ostbd;		/* Out of Sequence TxBD */
329 	u32	ostbdp;		/* Out of Sequence Tx Data Buffer Pointer */
330 	u32	res2b8[18];
331 
332 	/* Receive Control and Status Registers (0x2_n300) */
333 	u32	rctrl;		/* Receive Control */
334 	u32	rstat;		/* Receive Status */
335 	u32	res308;
336 	u32	rbdlen;		/* RxBD Data Length */
337 	u32	res310[4];
338 	u32	res320;
339 	u32	crbptr;	/* Current Receive Buffer Pointer */
340 	u32	res328[6];
341 	u32	mrblr;	/* Maximum Receive Buffer Length */
342 	u32	res344[16];
343 	u32	rbptr;	/* RxBD Pointer */
344 	u32	res388[30];
345 	/* (0x2_n400) */
346 	u32	res400;
347 	u32	rbase;	/* RxBD Base Address */
348 	u32	res408[62];
349 
350 	/* MAC Registers (0x2_n500) */
351 	u32	maccfg1;	/* MAC Configuration #1 */
352 	u32	maccfg2;	/* MAC Configuration #2 */
353 	u32	ipgifg;		/* Inter Packet Gap/Inter Frame Gap */
354 	u32	hafdup;		/* Half-duplex */
355 	u32	maxfrm;		/* Maximum Frame */
356 	u32	res514;
357 	u32	res518;
358 
359 	u32	res51c;
360 
361 	u32	resmdio[6];
362 
363 	u32	res538;
364 
365 	u32	ifstat;		/* Interface Status */
366 	u32	macstnaddr1;	/* Station Address, part 1 */
367 	u32	macstnaddr2;	/* Station Address, part 2 */
368 	u32	res548[46];
369 
370 	/* (0x2_n600) */
371 	u32	res600[32];
372 
373 	/* RMON MIB Registers (0x2_n680-0x2_n73c) */
374 	struct tsec_rmon_mib	rmon;
375 	u32	res740[48];
376 
377 	/* Hash Function Registers (0x2_n800) */
378 	struct tsec_hash_regs	hash;
379 
380 	u32	res900[128];
381 
382 	/* Pattern Registers (0x2_nb00) */
383 	u32	resb00[62];
384 	u32	attr; /* Default Attribute Register */
385 	u32	attreli; /* Default Attribute Extract Length and Index */
386 
387 	/* TSEC Future Expansion Space (0x2_nc00-0x2_nffc) */
388 	u32	resc00[256];
389 };
390 
391 #define TSEC_GIGABIT (1 << 0)
392 
393 /* These flags currently only have meaning if we're using the eTSEC */
394 #define TSEC_REDUCED	(1 << 1)	/* MAC-PHY interface uses RGMII */
395 #define TSEC_SGMII	(1 << 2)	/* MAC-PHY interface uses SGMII */
396 
397 struct tsec_private {
398 	struct tsec __iomem *regs;
399 	struct tsec_mii_mng __iomem *phyregs_sgmii;
400 	struct phy_device *phydev;
401 	phy_interface_t interface;
402 	struct mii_dev *bus;
403 	uint phyaddr;
404 	char mii_devname[16];
405 	u32 flags;
406 };
407 
408 struct tsec_info_struct {
409 	struct tsec __iomem *regs;
410 	struct tsec_mii_mng __iomem *miiregs_sgmii;
411 	char *devname;
412 	char *mii_devname;
413 	phy_interface_t interface;
414 	unsigned int phyaddr;
415 	u32 flags;
416 };
417 
418 int tsec_standard_init(bd_t *bis);
419 int tsec_eth_init(bd_t *bis, struct tsec_info_struct *tsec_info, int num);
420 
421 #endif /* __TSEC_H */
422