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)
7 * See file CREDITS for list of people who contributed to this
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.
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.
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,
29 #include <linux/ctype.h>
31 #include "../common/eeprom.h"
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"
37 #define MAX_NUM_PORTS 8 /* This value must be 8 as defined in doc */
40 * static eeprom: EEPROM layout for CCID or NXID formats
42 * See application note AN3638 for details.
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 */
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 */
76 /* Set to 1 if we've read EEPROM into memory */
77 static int has_been_read = 0;
79 #ifdef CONFIG_SYS_I2C_EEPROM_NXID
80 /* Is this a valid NXID EEPROM? */
81 #define is_valid ((e.id[0] == 'N') || (e.id[1] == 'X') || \
82 (e.id[2] == 'I') || (e.id[3] == 'D'))
85 #ifdef CONFIG_SYS_I2C_EEPROM_CCID
86 /* Is this a valid CCID EEPROM? */
87 #define is_valid ((e.id[0] == 'C') || (e.id[1] == 'C') || \
88 (e.id[2] == 'I') || (e.id[3] == 'D'))
92 * show_eeprom - display the contents of the EEPROM
94 static void show_eeprom(void)
99 /* EEPROM tag ID, either CCID or NXID */
100 #ifdef CONFIG_SYS_I2C_EEPROM_NXID
101 printf("ID: %c%c%c%c v%u\n", e.id[0], e.id[1], e.id[2], e.id[3],
102 be32_to_cpu(e.version));
104 printf("ID: %c%c%c%c\n", e.id[0], e.id[1], e.id[2], e.id[3]);
108 printf("SN: %s\n", e.sn);
111 #ifdef CONFIG_SYS_I2C_EEPROM_NXID
112 printf("Errata: %s\n", e.errata);
114 printf("Errata: %c%c\n",
115 e.errata[0] ? e.errata[0] : '.',
116 e.errata[1] ? e.errata[1] : '.');
119 /* Build date, BCD date values, as YYMMDDhhmmss */
120 printf("Build date: 20%02x/%02x/%02x %02x:%02x:%02x %s\n",
121 e.date[0], e.date[1], e.date[2],
122 e.date[3] & 0x7F, e.date[4], e.date[5],
123 e.date[3] & 0x80 ? "PM" : "");
125 /* Show MAC addresses */
126 for (i = 0; i < min(e.mac_count, MAX_NUM_PORTS); i++) {
130 printf("Eth%u: %02x:%02x:%02x:%02x:%02x:%02x\n", i,
131 p[0], p[1], p[2], p[3], p[4], p[5]);
134 crc = crc32(0, (void *)&e, sizeof(e) - 4);
136 if (crc == be32_to_cpu(e.crc))
137 printf("CRC: %08x\n", be32_to_cpu(e.crc));
139 printf("CRC: %08x (should be %08x)\n",
140 be32_to_cpu(e.crc), crc);
143 printf("EEPROM dump: (0x%x bytes)\n", sizeof(e));
144 for (i = 0; i < sizeof(e); i++) {
147 printf("%02X ", ((u8 *)&e)[i]);
148 if (((i % 16) == 15) || (i == sizeof(e) - 1))
155 * read_eeprom - read the EEPROM into memory
157 static int read_eeprom(void)
160 #ifdef CONFIG_SYS_EEPROM_BUS_NUM
167 #ifdef CONFIG_SYS_EEPROM_BUS_NUM
168 bus = i2c_get_bus_num();
169 i2c_set_bus_num(CONFIG_SYS_EEPROM_BUS_NUM);
172 ret = i2c_read(CONFIG_SYS_I2C_EEPROM_ADDR, 0, CONFIG_SYS_I2C_EEPROM_ADDR_LEN,
173 (void *)&e, sizeof(e));
175 #ifdef CONFIG_SYS_EEPROM_BUS_NUM
176 i2c_set_bus_num(bus);
183 has_been_read = (ret == 0) ? 1 : 0;
189 * prog_eeprom - write the EEPROM from memory
191 static int prog_eeprom(void)
196 #ifdef CONFIG_SYS_EEPROM_BUS_NUM
200 /* Set the reserved values to 0xFF */
201 #ifdef CONFIG_SYS_I2C_EEPROM_NXID
203 memset(e.res_1, 0xFF, sizeof(e.res_1));
205 memset(e.res_0, 0xFF, sizeof(e.res_0));
209 crc = crc32(0, (void *)&e, length - 4);
210 e.crc = cpu_to_be32(crc);
212 #ifdef CONFIG_SYS_EEPROM_BUS_NUM
213 bus = i2c_get_bus_num();
214 i2c_set_bus_num(CONFIG_SYS_EEPROM_BUS_NUM);
217 for (i = 0, p = &e; i < length; i += 8, p += 8) {
218 ret = i2c_write(CONFIG_SYS_I2C_EEPROM_ADDR, i, CONFIG_SYS_I2C_EEPROM_ADDR_LEN,
219 p, min((length - i), 8));
222 udelay(5000); /* 5ms write cycle timing */
225 #ifdef CONFIG_SYS_EEPROM_BUS_NUM
226 i2c_set_bus_num(bus);
230 printf("Programming failed.\n");
234 printf("Programming passed.\n");
239 * h2i - converts hex character into a number
241 * This function takes a hexadecimal character (e.g. '7' or 'C') and returns
242 * the integer equivalent.
244 static inline u8 h2i(char p)
246 if ((p >= '0') && (p <= '9'))
249 if ((p >= 'A') && (p <= 'F'))
250 return (p - 'A') + 10;
252 if ((p >= 'a') && (p <= 'f'))
253 return (p - 'a') + 10;
259 * set_date - stores the build date into the EEPROM
261 * This function takes a pointer to a string in the format "YYMMDDhhmmss"
262 * (2-digit year, 2-digit month, etc), converts it to a 6-byte BCD string,
263 * and stores it in the build date field of the EEPROM local copy.
265 static void set_date(const char *string)
269 if (strlen(string) != 12) {
270 printf("Usage: mac date YYMMDDhhmmss\n");
274 for (i = 0; i < 6; i++)
275 e.date[i] = h2i(string[2 * i]) << 4 | h2i(string[2 * i + 1]);
279 * set_mac_address - stores a MAC address into the EEPROM
281 * This function takes a pointer to MAC address string
282 * (i.e."XX:XX:XX:XX:XX:XX", where "XX" is a two-digit hex number) and
283 * stores it in one of the MAC address fields of the EEPROM local copy.
285 static void set_mac_address(unsigned int index, const char *string)
287 char *p = (char *) string;
291 printf("Usage: mac <n> XX:XX:XX:XX:XX:XX\n");
295 for (i = 0; *p && (i < 6); i++) {
296 e.mac[index][i] = simple_strtoul(p, &p, 16);
302 int do_mac(cmd_tbl_t *cmdtp, int flag, int argc, char *argv[])
319 if ((cmd == 'i') && (argc > 2)) {
320 for (i = 0; i < 4; i++)
321 e.id[i] = argv[2][i];
326 printf("Please read the EEPROM ('r') and/or set the ID ('i') first.\n");
343 /* We know we have at least one parameter */
346 case 'n': /* serial number */
347 memset(e.sn, 0, sizeof(e.sn));
348 strncpy((char *)e.sn, argv[2], sizeof(e.sn) - 1);
350 case 'e': /* errata */
351 #ifdef CONFIG_SYS_I2C_EEPROM_NXID
352 memset(e.errata, 0, 5);
353 strncpy((char *)e.errata, argv[2], 4);
355 e.errata[0] = argv[2][0];
356 e.errata[1] = argv[2][1];
359 case 'd': /* date BCD format YYMMDDhhmmss */
362 case 'p': /* MAC table size */
363 e.mac_count = simple_strtoul(argv[2], NULL, 16);
365 case '0' ... '7': /* "mac 0" through "mac 7" */
366 set_mac_address(cmd - '0', argv[2]);
378 * mac_read_from_eeprom - read the MAC addresses from EEPROM
380 * This function reads the MAC addresses from EEPROM and sets the
381 * appropriate environment variables for each one read.
383 * The environment variables are only set if they haven't been set already.
384 * This ensures that any user-saved variables are never overwritten.
386 * This function must be called after relocation.
388 int mac_read_from_eeprom(void)
393 printf("Read failed.\n");
398 printf("Invalid ID (%02x %02x %02x %02x)\n", e.id[0], e.id[1], e.id[2], e.id[3]);
402 if (be32_to_cpu(e.crc) != 0xFFFFFFFF) {
403 u32 crc = crc32(0, (void *)&e, sizeof(e) - 4);
405 if (crc != be32_to_cpu(e.crc)) {
406 printf("CRC mismatch (%08x != %08x).\n", crc,
412 /* Check the number of MAC addresses which is limited to
415 if (e.mac_count > MAX_NUM_PORTS) {
416 printf("Warning: The number of MAC addresses is greater"
417 " than %u, force it to %u.\n", MAX_NUM_PORTS,
419 e.mac_count = MAX_NUM_PORTS;
422 for (i = 0; i < e.mac_count; i++) {
423 if (memcmp(&e.mac[i], "\0\0\0\0\0\0", 6) &&
424 memcmp(&e.mac[i], "\xFF\xFF\xFF\xFF\xFF\xFF", 6)) {
428 sprintf(ethaddr, "%02X:%02X:%02X:%02X:%02X:%02X",
435 sprintf(enetvar, i ? "eth%daddr" : "ethaddr", i);
436 /* Only initialize environment variables that are blank
437 * (i.e. have not yet been set)
439 if (!getenv(enetvar))
440 setenv(enetvar, ethaddr);
447 #ifdef CONFIG_SYS_I2C_EEPROM_CCID
450 * get_cpu_board_revision - get the CPU board revision on 85xx boards
452 * Read the EEPROM to determine the board revision.
454 * This function is called before relocation, so we need to read a private
455 * copy of the EEPROM into a local variable on the stack.
457 * Also, we assume that CONFIG_SYS_EEPROM_BUS_NUM == CONFIG_SYS_SPD_BUS_NUM. The global
458 * variable i2c_bus_num must be compile-time initialized to CONFIG_SYS_SPD_BUS_NUM,
459 * so that the SPD code will work. This means that all pre-relocation I2C
460 * operations can only occur on the CONFIG_SYS_SPD_BUS_NUM bus. So if
461 * CONFIG_SYS_EEPROM_BUS_NUM != CONFIG_SYS_SPD_BUS_NUM, then we can't read the EEPROM when
462 * this function is called. Oh well.
464 unsigned int get_cpu_board_revision(void)
466 struct board_eeprom {
467 u32 id; /* 0x00 - 0x03 EEPROM Tag 'CCID' */
468 u8 major; /* 0x04 Board revision, major */
469 u8 minor; /* 0x05 Board revision, minor */
472 i2c_read(CONFIG_SYS_I2C_EEPROM_ADDR, 0, CONFIG_SYS_I2C_EEPROM_ADDR_LEN,
473 (void *)&be, sizeof(be));
475 if (be.id != (('C' << 24) | ('C' << 16) | ('I' << 8) | 'D'))
476 return MPC85XX_CPU_BOARD_REV(0, 0);
478 if ((be.major == 0xff) && (be.minor == 0xff))
479 return MPC85XX_CPU_BOARD_REV(0, 0);
481 return MPC85XX_CPU_BOARD_REV(be.major, be.minor);