1 /*
2  * Copyright 2006, 2008-2009 Freescale Semiconductor
3  * York Sun (yorksun@freescale.com)
4  * Haiying Wang (haiying.wang@freescale.com)
5  * Timur Tabi (timur@freescale.com)
6  *
7  * See file CREDITS for list of people who contributed to this
8  * project.
9  *
10  * This program is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU General Public License as
12  * published by the Free Software Foundation; either version 2 of
13  * the License, or (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
23  * MA 02111-1307 USA
24  */
25 
26 #include <common.h>
27 #include <command.h>
28 #include <i2c.h>
29 #include <linux/ctype.h>
30 
31 #include "../common/eeprom.h"
32 
33 #if !defined(CONFIG_SYS_I2C_EEPROM_CCID) && !defined(CONFIG_SYS_I2C_EEPROM_NXID)
34 #error "Please define either CONFIG_SYS_I2C_EEPROM_CCID or CONFIG_SYS_I2C_EEPROM_NXID"
35 #endif
36 
37 #define MAX_NUM_PORTS	8	/* This value must be 8 as defined in doc */
38 
39 /**
40  * static eeprom: EEPROM layout for CCID or NXID formats
41  *
42  * See application note AN3638 for details.
43  */
44 static struct __attribute__ ((__packed__)) eeprom {
45 #ifdef CONFIG_SYS_I2C_EEPROM_CCID
46 	u8 id[4];         /* 0x00 - 0x03 EEPROM Tag 'CCID' */
47 	u8 major;         /* 0x04        Board revision, major */
48 	u8 minor;         /* 0x05        Board revision, minor */
49 	u8 sn[10];        /* 0x06 - 0x0F Serial Number*/
50 	u8 errata[2];     /* 0x10 - 0x11 Errata Level */
51 	u8 date[6];       /* 0x12 - 0x17 Build Date */
52 	u8 res_0[40];     /* 0x18 - 0x3f Reserved */
53 	u8 mac_count;     /* 0x40        Number of MAC addresses */
54 	u8 mac_flag;      /* 0x41        MAC table flags */
55 	u8 mac[MAX_NUM_PORTS][6];     /* 0x42 - 0x71 MAC addresses */
56 	u32 crc;          /* 0x72        CRC32 checksum */
57 #endif
58 #ifdef CONFIG_SYS_I2C_EEPROM_NXID
59 	u8 id[4];         /* 0x00 - 0x03 EEPROM Tag 'NXID' */
60 	u8 sn[12];        /* 0x04 - 0x0F Serial Number */
61 	u8 errata[5];     /* 0x10 - 0x14 Errata Level */
62 	u8 date[6];       /* 0x15 - 0x1a Build Date */
63 	u8 res_0;         /* 0x1b        Reserved */
64 	u32 version;      /* 0x1c - 0x1f NXID Version */
65 	u8 tempcal[8];    /* 0x20 - 0x27 Temperature Calibration Factors */
66 	u8 tempcalsys[2]; /* 0x28 - 0x29 System Temperature Calibration Factors */
67 	u8 tempcalflags;  /* 0x2a        Temperature Calibration Flags */
68 	u8 res_1[21];     /* 0x2b - 0x3f Reserved */
69 	u8 mac_count;     /* 0x40        Number of MAC addresses */
70 	u8 mac_flag;      /* 0x41        MAC table flags */
71 	u8 mac[MAX_NUM_PORTS][6];     /* 0x42 - 0x71 MAC addresses */
72 	u32 crc;          /* 0x72        CRC32 checksum */
73 #endif
74 } e;
75 
76 /* Set to 1 if we've read EEPROM into memory */
77 static int has_been_read = 0;
78 
79 #ifdef CONFIG_SYS_I2C_EEPROM_NXID
80 /* Is this a valid NXID EEPROM? */
81 #define is_valid (*((u32 *)e.id) == (('N' << 24) | ('X' << 16) | ('I' << 8) | 'D'))
82 #endif
83 
84 #ifdef CONFIG_SYS_I2C_EEPROM_CCID
85 /* Is this a valid CCID EEPROM? */
86 #define is_valid (*((u32 *)e.id) == (('C' << 24) | ('C' << 16) | ('I' << 8) | 'D'))
87 #endif
88 
89 /**
90  * show_eeprom - display the contents of the EEPROM
91  */
92 static void show_eeprom(void)
93 {
94 	int i;
95 	unsigned int crc;
96 
97 	/* EEPROM tag ID, either CCID or NXID */
98 #ifdef CONFIG_SYS_I2C_EEPROM_NXID
99 	printf("ID: %c%c%c%c v%u\n", e.id[0], e.id[1], e.id[2], e.id[3],
100 		be32_to_cpu(e.version));
101 #else
102 	printf("ID: %c%c%c%c\n", e.id[0], e.id[1], e.id[2], e.id[3]);
103 #endif
104 
105 	/* Serial number */
106 	printf("SN: %s\n", e.sn);
107 
108 	/* Errata level. */
109 #ifdef CONFIG_SYS_I2C_EEPROM_NXID
110 	printf("Errata: %s\n", e.errata);
111 #else
112 	printf("Errata: %c%c\n",
113 		e.errata[0] ? e.errata[0] : '.',
114 		e.errata[1] ? e.errata[1] : '.');
115 #endif
116 
117 	/* Build date, BCD date values, as YYMMDDhhmmss */
118 	printf("Build date: 20%02x/%02x/%02x %02x:%02x:%02x %s\n",
119 		e.date[0], e.date[1], e.date[2],
120 		e.date[3] & 0x7F, e.date[4], e.date[5],
121 		e.date[3] & 0x80 ? "PM" : "");
122 
123 	/* Show MAC addresses  */
124 	for (i = 0; i < min(e.mac_count, MAX_NUM_PORTS); i++) {
125 
126 		u8 *p = e.mac[i];
127 
128 		printf("Eth%u: %02x:%02x:%02x:%02x:%02x:%02x\n", i,
129 			p[0], p[1], p[2], p[3],	p[4], p[5]);
130 	}
131 
132 	crc = crc32(0, (void *)&e, sizeof(e) - 4);
133 
134 	if (crc == be32_to_cpu(e.crc))
135 		printf("CRC: %08x\n", be32_to_cpu(e.crc));
136 	else
137 		printf("CRC: %08x (should be %08x)\n",
138 			be32_to_cpu(e.crc), crc);
139 
140 #ifdef DEBUG
141 	printf("EEPROM dump: (0x%x bytes)\n", sizeof(e));
142 	for (i = 0; i < sizeof(e); i++) {
143 		if ((i % 16) == 0)
144 			printf("%02X: ", i);
145 		printf("%02X ", ((u8 *)&e)[i]);
146 		if (((i % 16) == 15) || (i == sizeof(e) - 1))
147 			printf("\n");
148 	}
149 #endif
150 }
151 
152 /**
153  * read_eeprom - read the EEPROM into memory
154  */
155 static int read_eeprom(void)
156 {
157 	int ret;
158 #ifdef CONFIG_SYS_EEPROM_BUS_NUM
159 	unsigned int bus;
160 #endif
161 
162 	if (has_been_read)
163 		return 0;
164 
165 #ifdef CONFIG_SYS_EEPROM_BUS_NUM
166 	bus = i2c_get_bus_num();
167 	i2c_set_bus_num(CONFIG_SYS_EEPROM_BUS_NUM);
168 #endif
169 
170 	ret = i2c_read(CONFIG_SYS_I2C_EEPROM_ADDR, 0, CONFIG_SYS_I2C_EEPROM_ADDR_LEN,
171 		(void *)&e, sizeof(e));
172 
173 #ifdef CONFIG_SYS_EEPROM_BUS_NUM
174 	i2c_set_bus_num(bus);
175 #endif
176 
177 #ifdef DEBUG
178 	show_eeprom();
179 #endif
180 
181 	has_been_read = (ret == 0) ? 1 : 0;
182 
183 	return ret;
184 }
185 
186 /**
187  * prog_eeprom - write the EEPROM from memory
188  */
189 static int prog_eeprom(void)
190 {
191 	int ret, i, length;
192 	unsigned int crc;
193 	void *p;
194 #ifdef CONFIG_SYS_EEPROM_BUS_NUM
195 	unsigned int bus;
196 #endif
197 
198 	/* Set the reserved values to 0xFF   */
199 #ifdef CONFIG_SYS_I2C_EEPROM_NXID
200 	e.res_0 = 0xFF;
201 	memset(e.res_1, 0xFF, sizeof(e.res_1));
202 #else
203 	memset(e.res_0, 0xFF, sizeof(e.res_0));
204 #endif
205 
206 	length = sizeof(e);
207 	crc = crc32(0, (void *)&e, length - 4);
208 	e.crc = cpu_to_be32(crc);
209 
210 #ifdef CONFIG_SYS_EEPROM_BUS_NUM
211 	bus = i2c_get_bus_num();
212 	i2c_set_bus_num(CONFIG_SYS_EEPROM_BUS_NUM);
213 #endif
214 
215 	for (i = 0, p = &e; i < length; i += 8, p += 8) {
216 		ret = i2c_write(CONFIG_SYS_I2C_EEPROM_ADDR, i, CONFIG_SYS_I2C_EEPROM_ADDR_LEN,
217 			p, min((length - i), 8));
218 		if (ret)
219 			break;
220 		udelay(5000);	/* 5ms write cycle timing */
221 	}
222 
223 #ifdef CONFIG_SYS_EEPROM_BUS_NUM
224 	i2c_set_bus_num(bus);
225 #endif
226 
227 	if (ret) {
228 		printf("Programming failed.\n");
229 		return -1;
230 	}
231 
232 	printf("Programming passed.\n");
233 	return 0;
234 }
235 
236 /**
237  * h2i - converts hex character into a number
238  *
239  * This function takes a hexadecimal character (e.g. '7' or 'C') and returns
240  * the integer equivalent.
241  */
242 static inline u8 h2i(char p)
243 {
244 	if ((p >= '0') && (p <= '9'))
245 		return p - '0';
246 
247 	if ((p >= 'A') && (p <= 'F'))
248 		return (p - 'A') + 10;
249 
250 	if ((p >= 'a') && (p <= 'f'))
251 		return (p - 'a') + 10;
252 
253 	return 0;
254 }
255 
256 /**
257  * set_date - stores the build date into the EEPROM
258  *
259  * This function takes a pointer to a string in the format "YYMMDDhhmmss"
260  * (2-digit year, 2-digit month, etc), converts it to a 6-byte BCD string,
261  * and stores it in the build date field of the EEPROM local copy.
262  */
263 static void set_date(const char *string)
264 {
265 	unsigned int i;
266 
267 	if (strlen(string) != 12) {
268 		printf("Usage: mac date YYMMDDhhmmss\n");
269 		return;
270 	}
271 
272 	for (i = 0; i < 6; i++)
273 		e.date[i] = h2i(string[2 * i]) << 4 | h2i(string[2 * i + 1]);
274 }
275 
276 /**
277  * set_mac_address - stores a MAC address into the EEPROM
278  *
279  * This function takes a pointer to MAC address string
280  * (i.e."XX:XX:XX:XX:XX:XX", where "XX" is a two-digit hex number) and
281  * stores it in one of the MAC address fields of the EEPROM local copy.
282  */
283 static void set_mac_address(unsigned int index, const char *string)
284 {
285 	char *p = (char *) string;
286 	unsigned int i;
287 
288 	if (!string) {
289 		printf("Usage: mac <n> XX:XX:XX:XX:XX:XX\n");
290 		return;
291 	}
292 
293 	for (i = 0; *p && (i < 6); i++) {
294 		e.mac[index][i] = simple_strtoul(p, &p, 16);
295 		if (*p == ':')
296 			p++;
297 	}
298 }
299 
300 int do_mac(cmd_tbl_t *cmdtp, int flag, int argc, char *argv[])
301 {
302 	int i;
303 	char cmd;
304 
305 	if (argc == 1) {
306 		show_eeprom();
307 		return 0;
308 	}
309 
310 	cmd = argv[1][0];
311 
312 	if (cmd == 'r') {
313 		read_eeprom();
314 		return 0;
315 	}
316 
317 	if ((cmd == 'i') && (argc > 2)) {
318 		for (i = 0; i < 4; i++)
319 			e.id[i] = argv[2][i];
320 		return 0;
321 	}
322 
323 	if (!is_valid) {
324 		printf("Please read the EEPROM ('r') and/or set the ID ('i') first.\n");
325 		return 0;
326 	}
327 
328 	if (argc == 2) {
329 		switch (cmd) {
330 		case 's':	/* save */
331 			prog_eeprom();
332 			break;
333 		default:
334 			cmd_usage(cmdtp);
335 			break;
336 		}
337 
338 		return 0;
339 	}
340 
341 	/* We know we have at least one parameter  */
342 
343 	switch (cmd) {
344 	case 'n':	/* serial number */
345 		memset(e.sn, 0, sizeof(e.sn));
346 		strncpy((char *)e.sn, argv[2], sizeof(e.sn) - 1);
347 		break;
348 	case 'e':	/* errata */
349 #ifdef CONFIG_SYS_I2C_EEPROM_NXID
350 		memset(e.errata, 0, 5);
351 		strncpy((char *)e.errata, argv[2], 4);
352 #else
353 		e.errata[0] = argv[2][0];
354 		e.errata[1] = argv[2][1];
355 #endif
356 		break;
357 	case 'd':	/* date BCD format YYMMDDhhmmss */
358 		set_date(argv[2]);
359 		break;
360 	case 'p':	/* MAC table size */
361 		e.mac_count = simple_strtoul(argv[2], NULL, 16);
362 		break;
363 	case '0' ... '7':	/* "mac 0" through "mac 7" */
364 		set_mac_address(cmd - '0', argv[2]);
365 		break;
366 	case 'h':	/* help */
367 	default:
368 		cmd_usage(cmdtp);
369 		break;
370 	}
371 
372 	return 0;
373 }
374 
375 /**
376  * mac_read_from_eeprom - read the MAC addresses from EEPROM
377  *
378  * This function reads the MAC addresses from EEPROM and sets the
379  * appropriate environment variables for each one read.
380  *
381  * The environment variables are only set if they haven't been set already.
382  * This ensures that any user-saved variables are never overwritten.
383  *
384  * This function must be called after relocation.
385  */
386 int mac_read_from_eeprom(void)
387 {
388 	unsigned int i;
389 
390 	if (read_eeprom()) {
391 		printf("Read failed.\n");
392 		return -1;
393 	}
394 
395 	if (!is_valid) {
396 		printf("Invalid ID (%02x %02x %02x %02x)\n", e.id[0], e.id[1], e.id[2], e.id[3]);
397 		return -1;
398 	}
399 
400 	if (be32_to_cpu(e.crc) != 0xFFFFFFFF) {
401 		u32 crc = crc32(0, (void *)&e, sizeof(e) - 4);
402 
403 		if (crc != be32_to_cpu(e.crc)) {
404 			printf("CRC mismatch (%08x != %08x).\n", crc,
405 				be32_to_cpu(e.crc));
406 			return -1;
407 		}
408 	}
409 
410 	/* Check the number of MAC addresses which is limited to
411 	 * MAX_NUM_PORTS.
412 	 */
413 	if (e.mac_count > MAX_NUM_PORTS) {
414 		printf("Warning: The number of MAC addresses is greater"
415 			" than %u, force it to %u.\n", MAX_NUM_PORTS,
416 			MAX_NUM_PORTS);
417 		e.mac_count = MAX_NUM_PORTS;
418 	}
419 
420 	for (i = 0; i < e.mac_count; i++) {
421 		if (memcmp(&e.mac[i], "\0\0\0\0\0\0", 6) &&
422 		    memcmp(&e.mac[i], "\xFF\xFF\xFF\xFF\xFF\xFF", 6)) {
423 			char ethaddr[18];
424 			char enetvar[9];
425 
426 			sprintf(ethaddr, "%02X:%02X:%02X:%02X:%02X:%02X",
427 				e.mac[i][0],
428 				e.mac[i][1],
429 				e.mac[i][2],
430 				e.mac[i][3],
431 				e.mac[i][4],
432 				e.mac[i][5]);
433 			sprintf(enetvar, i ? "eth%daddr" : "ethaddr", i);
434 			/* Only initialize environment variables that are blank
435 			 * (i.e. have not yet been set)
436 			 */
437 			if (!getenv(enetvar))
438 				setenv(enetvar, ethaddr);
439 		}
440 	}
441 
442 	return 0;
443 }
444 
445 #ifdef CONFIG_SYS_I2C_EEPROM_CCID
446 
447 /**
448  * get_cpu_board_revision - get the CPU board revision on 85xx boards
449  *
450  * Read the EEPROM to determine the board revision.
451  *
452  * This function is called before relocation, so we need to read a private
453  * copy of the EEPROM into a local variable on the stack.
454  *
455  * Also, we assume that CONFIG_SYS_EEPROM_BUS_NUM == CONFIG_SYS_SPD_BUS_NUM.  The global
456  * variable i2c_bus_num must be compile-time initialized to CONFIG_SYS_SPD_BUS_NUM,
457  * so that the SPD code will work.  This means that all pre-relocation I2C
458  * operations can only occur on the CONFIG_SYS_SPD_BUS_NUM bus.  So if
459  * CONFIG_SYS_EEPROM_BUS_NUM != CONFIG_SYS_SPD_BUS_NUM, then we can't read the EEPROM when
460  * this function is called.  Oh well.
461  */
462 unsigned int get_cpu_board_revision(void)
463 {
464 	struct board_eeprom {
465 		u32 id;           /* 0x00 - 0x03 EEPROM Tag 'CCID' */
466 		u8 major;         /* 0x04        Board revision, major */
467 		u8 minor;         /* 0x05        Board revision, minor */
468 	} be;
469 
470 	i2c_read(CONFIG_SYS_I2C_EEPROM_ADDR, 0, CONFIG_SYS_I2C_EEPROM_ADDR_LEN,
471 		(void *)&be, sizeof(be));
472 
473 	if (be.id != (('C' << 24) | ('C' << 16) | ('I' << 8) | 'D'))
474 		return MPC85XX_CPU_BOARD_REV(0, 0);
475 
476 	if ((be.major == 0xff) && (be.minor == 0xff))
477 		return MPC85XX_CPU_BOARD_REV(0, 0);
478 
479 	return MPC85XX_CPU_BOARD_REV(be.major, be.minor);
480 }
481 #endif
482