2 * Copyright 2006, 2008 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"
38 * static eeprom: EEPROM layout for CCID or NXID formats
40 * See application note AN3638 for details.
42 static struct __attribute__ ((__packed__
)) eeprom
{
43 #ifdef CONFIG_SYS_I2C_EEPROM_CCID
44 u8 id
[4]; /* 0x00 - 0x03 EEPROM Tag 'CCID' */
45 u8 major
; /* 0x04 Board revision, major */
46 u8 minor
; /* 0x05 Board revision, minor */
47 u8 sn
[10]; /* 0x06 - 0x0F Serial Number*/
48 u8 errata
[2]; /* 0x10 - 0x11 Errata Level */
49 u8 date
[6]; /* 0x12 - 0x17 Build Date */
50 u8 res_0
[40]; /* 0x18 - 0x3f Reserved */
51 u8 mac_count
; /* 0x40 Number of MAC addresses */
52 u8 mac_flag
; /* 0x41 MAC table flags */
53 u8 mac
[8][6]; /* 0x42 - 0x71 MAC addresses */
54 u32 crc
; /* 0x72 CRC32 checksum */
56 #ifdef CONFIG_SYS_I2C_EEPROM_NXID
57 u8 id
[4]; /* 0x00 - 0x03 EEPROM Tag 'NXID' */
58 u8 sn
[12]; /* 0x04 - 0x0F Serial Number */
59 u8 errata
[5]; /* 0x10 - 0x14 Errata Level */
60 u8 date
[6]; /* 0x15 - 0x1a Build Date */
61 u8 res_0
; /* 0x1b Reserved */
62 u32 version
; /* 0x1c - 0x1f NXID Version */
63 u8 tempcal
[8]; /* 0x20 - 0x27 Temperature Calibration Factors */
64 u8 tempcalsys
[2]; /* 0x28 - 0x29 System Temperature Calibration Factors */
65 u8 tempcalflags
; /* 0x2a Temperature Calibration Flags */
66 u8 res_1
[21]; /* 0x2b - 0x3f Reserved */
67 u8 mac_count
; /* 0x40 Number of MAC addresses */
68 u8 mac_flag
; /* 0x41 MAC table flags */
69 u8 mac
[8][6]; /* 0x42 - 0x71 MAC addresses */
70 u32 crc
; /* 0x72 CRC32 checksum */
74 /* Set to 1 if we've read EEPROM into memory */
75 static int has_been_read
= 0;
77 #ifdef CONFIG_SYS_I2C_EEPROM_NXID
78 /* Is this a valid NXID EEPROM? */
79 #define is_valid (*((u32 *)e.id) == (('N' << 24) | ('X' << 16) | ('I' << 8) | 'D'))
82 #ifdef CONFIG_SYS_I2C_EEPROM_CCID
83 /* Is this a valid CCID EEPROM? */
84 #define is_valid (*((u32 *)e.id) == (('C' << 24) | ('C' << 16) | ('I' << 8) | 'D'))
88 * show_eeprom - display the contents of the EEPROM
90 static void show_eeprom(void)
95 /* EEPROM tag ID, either CCID or NXID */
96 #ifdef CONFIG_SYS_I2C_EEPROM_NXID
97 printf("ID: %c%c%c%c v%u\n", e
.id
[0], e
.id
[1], e
.id
[2], e
.id
[3],
98 be32_to_cpu(e
.version
));
100 printf("ID: %c%c%c%c\n", e
.id
[0], e
.id
[1], e
.id
[2], e
.id
[3]);
104 printf("SN: %s\n", e
.sn
);
107 #ifdef CONFIG_SYS_I2C_EEPROM_NXID
108 printf("Errata: %s\n", e
.errata
);
110 printf("Errata: %c%c\n",
111 e
.errata
[0] ? e
.errata
[0] : '.',
112 e
.errata
[1] ? e
.errata
[1] : '.');
115 /* Build date, BCD date values, as YYMMDDhhmmss */
116 printf("Build date: 20%02x/%02x/%02x %02x:%02x:%02x %s\n",
117 e
.date
[0], e
.date
[1], e
.date
[2],
118 e
.date
[3] & 0x7F, e
.date
[4], e
.date
[5],
119 e
.date
[3] & 0x80 ? "PM" : "");
121 /* Show MAC addresses */
122 for (i
= 0; i
< min(e
.mac_count
, 8); i
++) {
125 printf("Eth%u: %02x:%02x:%02x:%02x:%02x:%02x\n", i
,
126 p
[0], p
[1], p
[2], p
[3], p
[4], p
[5]);
129 crc
= crc32(0, (void *)&e
, sizeof(e
) - 4);
131 if (crc
== be32_to_cpu(e
.crc
))
132 printf("CRC: %08x\n", be32_to_cpu(e
.crc
));
134 printf("CRC: %08x (should be %08x)\n",
135 be32_to_cpu(e
.crc
), crc
);
138 printf("EEPROM dump: (0x%x bytes)\n", sizeof(e
));
139 for (i
= 0; i
< sizeof(e
); i
++) {
142 printf("%02X ", ((u8
*)&e
)[i
]);
143 if (((i
% 16) == 15) || (i
== sizeof(e
) - 1))
150 * read_eeprom - read the EEPROM into memory
152 static int read_eeprom(void)
155 #ifdef CONFIG_SYS_EEPROM_BUS_NUM
162 #ifdef CONFIG_SYS_EEPROM_BUS_NUM
163 bus
= i2c_get_bus_num();
164 i2c_set_bus_num(CONFIG_SYS_EEPROM_BUS_NUM
);
167 ret
= i2c_read(CONFIG_SYS_I2C_EEPROM_ADDR
, 0, CONFIG_SYS_I2C_EEPROM_ADDR_LEN
,
168 (void *)&e
, sizeof(e
));
170 #ifdef CONFIG_SYS_EEPROM_BUS_NUM
171 i2c_set_bus_num(bus
);
178 has_been_read
= (ret
== 0) ? 1 : 0;
184 * prog_eeprom - write the EEPROM from memory
186 static int prog_eeprom(void)
191 #ifdef CONFIG_SYS_EEPROM_BUS_NUM
195 /* Set the reserved values to 0xFF */
196 #ifdef CONFIG_SYS_I2C_EEPROM_NXID
198 memset(e
.res_1
, 0xFF, sizeof(e
.res_1
));
200 memset(e
.res_0
, 0xFF, sizeof(e
.res_0
));
204 crc
= crc32(0, (void *)&e
, length
- 4);
205 e
.crc
= cpu_to_be32(crc
);
207 #ifdef CONFIG_SYS_EEPROM_BUS_NUM
208 bus
= i2c_get_bus_num();
209 i2c_set_bus_num(CONFIG_SYS_EEPROM_BUS_NUM
);
212 for (i
= 0, p
= &e
; i
< length
; i
+= 8, p
+= 8) {
213 ret
= i2c_write(CONFIG_SYS_I2C_EEPROM_ADDR
, i
, CONFIG_SYS_I2C_EEPROM_ADDR_LEN
,
214 p
, min((length
- i
), 8));
217 udelay(5000); /* 5ms write cycle timing */
220 #ifdef CONFIG_SYS_EEPROM_BUS_NUM
221 i2c_set_bus_num(bus
);
225 printf("Programming failed.\n");
229 printf("Programming passed.\n");
234 * h2i - converts hex character into a number
236 * This function takes a hexadecimal character (e.g. '7' or 'C') and returns
237 * the integer equivalent.
239 static inline u8
h2i(char p
)
241 if ((p
>= '0') && (p
<= '9'))
244 if ((p
>= 'A') && (p
<= 'F'))
245 return (p
- 'A') + 10;
247 if ((p
>= 'a') && (p
<= 'f'))
248 return (p
- 'a') + 10;
254 * set_date - stores the build date into the EEPROM
256 * This function takes a pointer to a string in the format "YYMMDDhhmmss"
257 * (2-digit year, 2-digit month, etc), converts it to a 6-byte BCD string,
258 * and stores it in the build date field of the EEPROM local copy.
260 static void set_date(const char *string
)
264 if (strlen(string
) != 12) {
265 printf("Usage: mac date YYMMDDhhmmss\n");
269 for (i
= 0; i
< 6; i
++)
270 e
.date
[i
] = h2i(string
[2 * i
]) << 4 | h2i(string
[2 * i
+ 1]);
274 * set_mac_address - stores a MAC address into the EEPROM
276 * This function takes a pointer to MAC address string
277 * (i.e."XX:XX:XX:XX:XX:XX", where "XX" is a two-digit hex number) and
278 * stores it in one of the MAC address fields of the EEPROM local copy.
280 static void set_mac_address(unsigned int index
, const char *string
)
282 char *p
= (char *) string
;
286 printf("Usage: mac <n> XX:XX:XX:XX:XX:XX\n");
290 for (i
= 0; *p
&& (i
< 6); i
++) {
291 e
.mac
[index
][i
] = simple_strtoul(p
, &p
, 16);
297 int do_mac(cmd_tbl_t
*cmdtp
, int flag
, int argc
, char *argv
[])
314 if ((cmd
== 'i') && (argc
> 2)) {
315 for (i
= 0; i
< 4; i
++)
316 e
.id
[i
] = argv
[2][i
];
321 printf("Please read the EEPROM ('r') and/or set the ID ('i') first.\n");
331 printf("Usage:\n%s\n", cmdtp
->usage
);
338 /* We know we have at least one parameter */
341 case 'n': /* serial number */
342 memset(e
.sn
, 0, sizeof(e
.sn
));
343 strncpy((char *)e
.sn
, argv
[2], sizeof(e
.sn
) - 1);
345 case 'e': /* errata */
346 #ifdef CONFIG_SYS_I2C_EEPROM_NXID
347 memset(e
.errata
, 0, 5);
348 strncpy((char *)e
.errata
, argv
[2], 4);
350 e
.errata
[0] = argv
[2][0];
351 e
.errata
[1] = argv
[2][1];
354 case 'd': /* date BCD format YYMMDDhhmmss */
357 case 'p': /* MAC table size */
358 e
.mac_count
= simple_strtoul(argv
[2], NULL
, 16);
360 case '0' ... '7': /* "mac 0" through "mac 7" */
361 set_mac_address(cmd
- '0', argv
[2]);
365 printf("Usage:\n%s\n", cmdtp
->usage
);
373 * mac_read_from_eeprom - read the MAC addresses from EEPROM
375 * This function reads the MAC addresses from EEPROM and sets the
376 * appropriate environment variables for each one read.
378 * The environment variables are only set if they haven't been set already.
379 * This ensures that any user-saved variables are never overwritten.
381 * This function must be called after relocation.
383 int mac_read_from_eeprom(void)
388 printf("Read failed.\n");
393 printf("Invalid ID (%02x %02x %02x %02x)\n", e
.id
[0], e
.id
[1], e
.id
[2], e
.id
[3]);
397 if (be32_to_cpu(e
.crc
) != 0xFFFFFFFF) {
398 u32 crc
= crc32(0, (void *)&e
, sizeof(e
) - 4);
400 if (crc
!= be32_to_cpu(e
.crc
)) {
401 printf("CRC mismatch (%08x != %08x).\n", crc
,
407 for (i
= 0; i
< min(4, e
.mac_count
); i
++) {
408 if (memcmp(&e
.mac
[i
], "\0\0\0\0\0\0", 6) &&
409 memcmp(&e
.mac
[i
], "\xFF\xFF\xFF\xFF\xFF\xFF", 6)) {
413 sprintf(ethaddr
, "%02X:%02X:%02X:%02X:%02X:%02X",
420 sprintf(enetvar
, i
? "eth%daddr" : "ethaddr", i
);
421 /* Only initialize environment variables that are blank
422 * (i.e. have not yet been set)
424 if (!getenv(enetvar
))
425 setenv(enetvar
, ethaddr
);
432 #ifdef CONFIG_SYS_I2C_EEPROM_CCID
435 * get_cpu_board_revision - get the CPU board revision on 85xx boards
437 * Read the EEPROM to determine the board revision.
439 * This function is called before relocation, so we need to read a private
440 * copy of the EEPROM into a local variable on the stack.
442 * Also, we assume that CONFIG_SYS_EEPROM_BUS_NUM == CONFIG_SYS_SPD_BUS_NUM. The global
443 * variable i2c_bus_num must be compile-time initialized to CONFIG_SYS_SPD_BUS_NUM,
444 * so that the SPD code will work. This means that all pre-relocation I2C
445 * operations can only occur on the CONFIG_SYS_SPD_BUS_NUM bus. So if
446 * CONFIG_SYS_EEPROM_BUS_NUM != CONFIG_SYS_SPD_BUS_NUM, then we can't read the EEPROM when
447 * this function is called. Oh well.
449 unsigned int get_cpu_board_revision(void)
451 struct board_eeprom
{
452 u32 id
; /* 0x00 - 0x03 EEPROM Tag 'CCID' */
453 u8 major
; /* 0x04 Board revision, major */
454 u8 minor
; /* 0x05 Board revision, minor */
457 i2c_read(CONFIG_SYS_I2C_EEPROM_ADDR
, 0, CONFIG_SYS_I2C_EEPROM_ADDR_LEN
,
458 (void *)&be
, sizeof(be
));
460 if (be
.id
!= (('C' << 24) | ('C' << 16) | ('I' << 8) | 'D'))
461 return MPC85XX_CPU_BOARD_REV(0, 0);
463 if ((be
.major
== 0xff) && (be
.minor
== 0xff))
464 return MPC85XX_CPU_BOARD_REV(0, 0);
466 return MPC85XX_CPU_BOARD_REV(be
.major
, be
.minor
);