xref: /openbmc/u-boot/drivers/net/phy/mv88e61xx.c (revision 33b1d3f4)
1 /*
2  * (C) Copyright 2009
3  * Marvell Semiconductor <www.marvell.com>
4  * Prafulla Wadaskar <prafulla@marvell.com>
5  *
6  * See file CREDITS for list of people who contributed to this
7  * project.
8  *
9  * This program is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU General Public License as
11  * published by the Free Software Foundation; either version 2 of
12  * the License, or (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	 See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
22  * MA 02110-1301 USA
23  */
24 
25 #include <common.h>
26 #include <netdev.h>
27 #include "mv88e61xx.h"
28 
29 #ifdef CONFIG_MV88E61XX_MULTICHIP_ADRMODE
30 /* Chip Address mode
31  * The Switch support two modes of operation
32  * 1. single chip mode and
33  * 2. Multi-chip mode
34  * Refer section 9.2 &9.3 in chip datasheet-02 for more details
35  *
36  * By default single chip mode is configured
37  * multichip mode operation can be configured in board header
38  */
39 static int mv88e61xx_busychk_multic(u32 devaddr)
40 {
41 	u32 reg = 0;
42 	u32 timeout = MV88E61XX_PHY_TIMEOUT;
43 
44 	/* Poll till SMIBusy bit is clear */
45 	do {
46 		miiphy_read(name, devaddr, 0x0, &reg);
47 		if (timeout-- == 0) {
48 			printf("SMI busy timeout\n");
49 			return -1;
50 		}
51 	} while (reg & (1 << 15));
52 	return 0;
53 }
54 
55 static void mv88e61xx_wr_phy(char *name, u32 phy_adr, u32 reg_ofs, u16 data)
56 {
57 	u16 reg;
58 	u32 mii_dev_addr;
59 
60 	/* command to read PHY dev address */
61 	if (!miiphy_read(name, 0xEE, 0xEE, &mii_dev_addr)) {
62 		printf("Error..could not read PHY dev address\n");
63 		return;
64 	}
65 	mv88e61xx_busychk_multic(mii_dev_addr);
66 	/* Write data to Switch indirect data register */
67 	miiphy_write(name, mii_dev_addr, 0x1, data);
68 	/* Write command to Switch indirect command register (write) */
69 	miiphy_write(name, mii_dev_addr, 0x0,
70 		     reg_ofs | (phy_adr << 5) | (1 << 10) | (1 << 12) | (1 <<
71 									 15));
72 }
73 
74 static void mv88e61xx_rd_phy(char *name, u32 phy_adr, u32 reg_ofs, u16 * data)
75 {
76 	u16 reg;
77 	u32 mii_dev_addr;
78 
79 	/* command to read PHY dev address */
80 	if (!miiphy_read(name, 0xEE, 0xEE, &mii_dev_addr)) {
81 		printf("Error..could not read PHY dev address\n");
82 		return;
83 	}
84 	mv88e61xx_busychk_multic(mii_dev_addr);
85 	/* Write command to Switch indirect command register (read) */
86 	miiphy_write(name, mii_dev_addr, 0x0,
87 		     reg_ofs | (phy_adr << 5) | (1 << 10) | (1 << 12) | (1 <<
88 									 15));
89 	mv88e61xx_busychk_multic(mii_dev_addr);
90 	/* Read data from Switch indirect data register */
91 	miiphy_read(name, mii_dev_addr, 0x1, (u16 *) & data);
92 }
93 #endif /* CONFIG_MV88E61XX_MULTICHIP_ADRMODE */
94 
95 static void mv88e61xx_port_vlan_config(struct mv88e61xx_config *swconfig,
96 				       u32 max_prtnum, u32 ports_ofs)
97 {
98 	u32 prt;
99 	u16 reg;
100 	char *name = swconfig->name;
101 	u32 cpu_port = swconfig->cpuport;
102 	u32 port_mask = swconfig->ports_enabled;
103 	enum mv88e61xx_cfg_vlan vlancfg = swconfig->vlancfg;
104 
105 	/* be sure all ports are disabled */
106 	for (prt = 0; prt < max_prtnum; prt++) {
107 		RD_PHY(name, ports_ofs + prt, MV88E61XX_PRT_CTRL_REG, &reg);
108 		reg &= ~0x3;
109 		WR_PHY(name, ports_ofs + prt, MV88E61XX_PRT_CTRL_REG, reg);
110 
111 		if (!(cpu_port & (1 << prt)))
112 			continue;
113 		/* Set CPU port VID to 0x1 */
114 		RD_PHY(name, (ports_ofs + prt), MV88E61XX_PRT_VID_REG, &reg);
115 		reg &= ~0xfff;
116 		reg |= 0x1;
117 		WR_PHY(name, (ports_ofs + prt), MV88E61XX_PRT_VID_REG, reg);
118 	}
119 
120 	/* Setting  Port default priority for all ports to zero */
121 	for (prt = 0; prt < max_prtnum; prt++) {
122 		RD_PHY(name, ports_ofs + prt, MV88E61XX_PRT_VID_REG, &reg);
123 		reg &= ~0xc000;
124 		WR_PHY(name, ports_ofs + prt, MV88E61XX_PRT_VID_REG, reg);
125 	}
126 	/* Setting VID and VID map for all ports except CPU port */
127 	for (prt = 0; prt < max_prtnum; prt++) {
128 		/* only for enabled ports */
129 		if ((1 << prt) & port_mask) {
130 			/* skip CPU port */
131 			if ((1 << prt) & cpu_port) {
132 				/*
133 				 * Set Vlan map table for cpu_port to see
134 				 * all ports
135 				 */
136 				RD_PHY(name, (ports_ofs + prt),
137 				       MV88E61XX_PRT_VMAP_REG, &reg);
138 				reg &= ~((1 << max_prtnum) - 1);
139 				reg |= port_mask & ~(1 << prt);
140 				WR_PHY(name, (ports_ofs + prt),
141 				       MV88E61XX_PRT_VMAP_REG, reg);
142 			} else {
143 
144 				/*
145 				 *  set Ports VLAN Mapping.
146 				 *      port prt <--> cpu_port VLAN #prt+1.
147 				 */
148 				RD_PHY(name, ports_ofs + prt,
149 				       MV88E61XX_PRT_VID_REG, &reg);
150 				reg &= ~0x0fff;
151 				reg |= (prt + 1);
152 				WR_PHY(name, ports_ofs + prt,
153 				       MV88E61XX_PRT_VID_REG, reg);
154 
155 				RD_PHY(name, ports_ofs + prt,
156 				       MV88E61XX_PRT_VMAP_REG, &reg);
157 				if (vlancfg == MV88E61XX_VLANCFG_DEFAULT) {
158 					/*
159 					 * all any port can send frames to all other ports
160 					 * ref: sec 3.2.1.1 of datasheet
161 					 */
162 					reg |= 0x03f;
163 					reg &= ~(1 << prt);
164 				} else if (vlancfg == MV88E61XX_VLANCFG_ROUTER) {
165 					/*
166 					 * all other ports can send frames to CPU port only
167 					 * ref: sec 3.2.1.2 of datasheet
168 					 */
169 					reg &= ~((1 << max_prtnum) - 1);
170 					reg |= cpu_port;
171 				}
172 				WR_PHY(name, ports_ofs + prt,
173 				       MV88E61XX_PRT_VMAP_REG, reg);
174 			}
175 		}
176 	}
177 
178 	/*
179 	 * enable only appropriate ports to forwarding mode
180 	 * and disable the others
181 	 */
182 	for (prt = 0; prt < max_prtnum; prt++) {
183 		if ((1 << prt) & port_mask) {
184 			RD_PHY(name, ports_ofs + prt,
185 			       MV88E61XX_PRT_CTRL_REG, &reg);
186 			reg |= 0x3;
187 			WR_PHY(name, ports_ofs + prt,
188 			       MV88E61XX_PRT_CTRL_REG, reg);
189 		} else {
190 			/* Disable port */
191 			RD_PHY(name, ports_ofs + prt,
192 			       MV88E61XX_PRT_CTRL_REG, &reg);
193 			reg &= ~0x3;
194 			WR_PHY(name, ports_ofs + prt,
195 			       MV88E61XX_PRT_CTRL_REG, reg);
196 		}
197 	}
198 }
199 
200 /*
201  * Make sure SMIBusy bit cleared before another
202  * SMI operation can take place
203  */
204 static int mv88e61xx_busychk(char *name)
205 {
206 	u32 reg = 0;
207 	u32 timeout = MV88E61XX_PHY_TIMEOUT;
208 	do {
209 		RD_PHY(name, MV88E61XX_GLB2REG_DEVADR,
210 		       MV88E61XX_PHY_CMD, (u16 *) & reg);
211 		if (timeout-- == 0) {
212 			printf("SMI busy timeout\n");
213 			return -1;
214 		}
215 	} while (reg & 1 << 28);	/* busy mask */
216 	return 0;
217 }
218 
219 /*
220  * Power up the specified port and reset PHY
221  */
222 static int mv88361xx_powerup(struct mv88e61xx_config *swconfig, u32 prt)
223 {
224 	char *name = swconfig->name;
225 
226 	/* Write Copper Specific control reg1 (0x14) for-
227 	 * Enable Phy power up
228 	 * Energy Detect on (sense&Xmit NLP Periodically
229 	 * reset other settings default
230 	 */
231 	WR_PHY(name, MV88E61XX_GLB2REG_DEVADR, MV88E61XX_PHY_DATA, 0x3360);
232 	WR_PHY(name, MV88E61XX_GLB2REG_DEVADR,
233 	       MV88E61XX_PHY_CMD, (0x9410 | (prt << 5)));
234 
235 	if (mv88e61xx_busychk(name))
236 		return -1;
237 
238 	/* Write PHY ctrl reg (0x0) to apply
239 	 * Phy reset (set bit 15 low)
240 	 * reset other default values
241 	 */
242 	WR_PHY(name, MV88E61XX_GLB2REG_DEVADR, MV88E61XX_PHY_DATA, 0x1140);
243 	WR_PHY(name, MV88E61XX_GLB2REG_DEVADR,
244 	       MV88E61XX_PHY_CMD, (0x9400 | (prt << 5)));
245 
246 	if (mv88e61xx_busychk(name))
247 		return -1;
248 
249 	return 0;
250 }
251 
252 /*
253  * Default Setup for LED[0]_Control (ref: Table 46 Datasheet-3)
254  * is set to "On-1000Mb/s Link, Off Else"
255  * This function sets it to "On-Link, Blink-Activity, Off-NoLink"
256  *
257  * This is optional settings may be needed on some boards
258  * to setup PHY LEDs default configuration to detect 10/100/1000Mb/s
259  * Link status
260  */
261 static int mv88361xx_led_init(struct mv88e61xx_config *swconfig, u32 prt)
262 {
263 	char *name = swconfig->name;
264 	u16 reg;
265 
266 	if (swconfig->led_init != MV88E61XX_LED_INIT_EN)
267 		return 0;
268 
269 	/* set page address to 3 */
270 	reg = 3;
271 	WR_PHY(name, MV88E61XX_GLB2REG_DEVADR, MV88E61XX_PHY_DATA, reg);
272 	WR_PHY(name, MV88E61XX_GLB2REG_DEVADR,
273 	       MV88E61XX_PHY_CMD, (1 << MV88E61XX_BUSY_OFST |
274 				   1 << MV88E61XX_MODE_OFST |
275 				   1 << MV88E61XX_OP_OFST |
276 				   prt << MV88E61XX_ADDR_OFST | 22));
277 
278 	if (mv88e61xx_busychk(name))
279 		return -1;
280 
281 	/* set LED Func Ctrl reg */
282 	reg = 1;	/* LED[0] On-Link, Blink-Activity, Off-NoLink */
283 	WR_PHY(name, MV88E61XX_GLB2REG_DEVADR, MV88E61XX_PHY_DATA, reg);
284 	WR_PHY(name, MV88E61XX_GLB2REG_DEVADR,
285 	       MV88E61XX_PHY_CMD, (1 << MV88E61XX_BUSY_OFST |
286 				   1 << MV88E61XX_MODE_OFST |
287 				   1 << MV88E61XX_OP_OFST |
288 				   prt << MV88E61XX_ADDR_OFST | 16));
289 
290 	if (mv88e61xx_busychk(name))
291 		return -1;
292 
293 	/* set page address to 0 */
294 	reg = 0;
295 	WR_PHY(name, MV88E61XX_GLB2REG_DEVADR, MV88E61XX_PHY_DATA, reg);
296 	WR_PHY(name, MV88E61XX_GLB2REG_DEVADR,
297 	       MV88E61XX_PHY_CMD, (1 << MV88E61XX_BUSY_OFST |
298 				   1 << MV88E61XX_MODE_OFST |
299 				   1 << MV88E61XX_OP_OFST |
300 				   prt << MV88E61XX_ADDR_OFST | 22));
301 
302 	if (mv88e61xx_busychk(name))
303 		return -1;
304 
305 	return 0;
306 }
307 
308 /*
309  * Reverse Transmit polarity for Media Dependent Interface
310  * Pins (MDIP) bits in Copper Specific Control Register 3
311  * (Page 0, Reg 20 for each phy (except cpu port)
312  * Reference: Section 1.1 Switch datasheet-3
313  *
314  * This is optional settings may be needed on some boards
315  * for PHY<->magnetics h/w tuning
316  */
317 static int mv88361xx_reverse_mdipn(struct mv88e61xx_config *swconfig, u32 prt)
318 {
319 	char *name = swconfig->name;
320 	u16 reg;
321 
322 	if (swconfig->mdip != MV88E61XX_MDIP_REVERSE)
323 		return 0;
324 
325 	reg = 0x0f;		/*Reverse MDIP/N[3:0] bits */
326 	WR_PHY(name, MV88E61XX_GLB2REG_DEVADR, MV88E61XX_PHY_DATA, reg);
327 	WR_PHY(name, MV88E61XX_GLB2REG_DEVADR,
328 	       MV88E61XX_PHY_CMD, (1 << MV88E61XX_BUSY_OFST |
329 				   1 << MV88E61XX_MODE_OFST |
330 				   1 << MV88E61XX_OP_OFST |
331 				   prt << MV88E61XX_ADDR_OFST | 20));
332 
333 	if (mv88e61xx_busychk(name))
334 		return -1;
335 
336 	return 0;
337 }
338 
339 /*
340  * Marvell 88E61XX Switch initialization
341  */
342 int mv88e61xx_switch_initialize(struct mv88e61xx_config *swconfig)
343 {
344 	u32 prt;
345 	u16 reg;
346 	char *idstr;
347 	char *name = swconfig->name;
348 
349 	if (miiphy_set_current_dev(name)) {
350 		printf("%s failed\n", __FUNCTION__);
351 		return -1;
352 	}
353 
354 	if (!(swconfig->cpuport & ((1 << 4) | (1 << 5)))) {
355 		swconfig->cpuport = (1 << 5);
356 		printf("Invalid cpu port config, using default port5\n");
357 	}
358 
359 	RD_PHY(name, MV88E61XX_PRT_OFST, PHY_PHYIDR2, &reg);
360 	reg &= 0xfff0;
361 	if (reg == 0x1610)
362 		idstr = "88E6161";
363 	if (reg == 0x1650)
364 		idstr = "88E6165";
365 	if (reg == 0x1210) {
366 		idstr = "88E6123";
367 		/* ports 2,3,4 not available */
368 		swconfig->ports_enabled &= 0x023;
369 	}
370 
371 	/* Port based VLANs configuration */
372 	if ((swconfig->vlancfg == MV88E61XX_VLANCFG_DEFAULT)
373 	    || (swconfig->vlancfg == MV88E61XX_VLANCFG_ROUTER))
374 		mv88e61xx_port_vlan_config(swconfig, MV88E61XX_MAX_PORTS_NUM,
375 					   MV88E61XX_PRT_OFST);
376 	else {
377 		printf("Unsupported mode %s failed\n", __FUNCTION__);
378 		return -1;
379 	}
380 
381 	if (swconfig->rgmii_delay == MV88E61XX_RGMII_DELAY_EN) {
382 		/*
383 		 * Enable RGMII delay on Tx and Rx for CPU port
384 		 * Ref: sec 9.5 of chip datasheet-02
385 		 */
386 		WR_PHY(name, MV88E61XX_PRT_OFST + 5,
387 		       MV88E61XX_RGMII_TIMECTRL_REG, 0x18);
388 		WR_PHY(name, MV88E61XX_PRT_OFST + 4,
389 		       MV88E61XX_RGMII_TIMECTRL_REG, 0xc1e7);
390 	}
391 
392 	for (prt = 0; prt < MV88E61XX_MAX_PORTS_NUM; prt++) {
393 		if (!((1 << prt) & swconfig->cpuport)) {
394 
395 			if (mv88361xx_led_init(swconfig, prt))
396 				return -1;
397 			if (mv88361xx_reverse_mdipn(swconfig, prt))
398 				return -1;
399 			if (mv88361xx_powerup(swconfig, prt))
400 				return -1;
401 		}
402 
403 		/*Program port state */
404 		RD_PHY(name, MV88E61XX_PRT_OFST + prt,
405 		       MV88E61XX_PRT_CTRL_REG, &reg);
406 		WR_PHY(name, MV88E61XX_PRT_OFST + prt,
407 		       MV88E61XX_PRT_CTRL_REG,
408 		       reg | (swconfig->portstate & 0x03));
409 	}
410 
411 	printf("%s Initialized on %s\n", idstr, name);
412 	return 0;
413 }
414