1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright 2006, 2008-2009, 2011 Freescale Semiconductor
4 * York Sun (yorksun@freescale.com)
5 * Haiying Wang (haiying.wang@freescale.com)
6 * Timur Tabi (timur@freescale.com)
14 #include <linux/ctype.h>
15 #include <linux/delay.h>
16 #include <u-boot/crc.h>
18 #ifdef CONFIG_SYS_I2C_EEPROM_CCID
19 #include "../common/eeprom.h"
20 #define MAX_NUM_PORTS 8
23 #ifdef CONFIG_SYS_I2C_EEPROM_NXID
24 /* some boards with non-256-bytes EEPROM have special define */
25 /* for MAX_NUM_PORTS in board-specific file */
27 #define MAX_NUM_PORTS 16
29 #define NXID_VERSION 1
33 * static eeprom: EEPROM layout for CCID or NXID formats
35 * See application note AN3638 for details.
37 static struct __attribute__ ((__packed__)) eeprom {
38 #ifdef CONFIG_SYS_I2C_EEPROM_CCID
39 u8 id[4]; /* 0x00 - 0x03 EEPROM Tag 'CCID' */
40 u8 major; /* 0x04 Board revision, major */
41 u8 minor; /* 0x05 Board revision, minor */
42 u8 sn[10]; /* 0x06 - 0x0F Serial Number*/
43 u8 errata[2]; /* 0x10 - 0x11 Errata Level */
44 u8 date[6]; /* 0x12 - 0x17 Build Date */
45 u8 res_0[40]; /* 0x18 - 0x3f Reserved */
46 u8 mac_count; /* 0x40 Number of MAC addresses */
47 u8 mac_flag; /* 0x41 MAC table flags */
48 u8 mac[MAX_NUM_PORTS][6]; /* 0x42 - 0x71 MAC addresses */
49 u32 crc; /* 0x72 CRC32 checksum */
51 #ifdef CONFIG_SYS_I2C_EEPROM_NXID
52 u8 id[4]; /* 0x00 - 0x03 EEPROM Tag 'NXID' */
53 u8 sn[12]; /* 0x04 - 0x0F Serial Number */
54 u8 errata[5]; /* 0x10 - 0x14 Errata Level */
55 u8 date[6]; /* 0x15 - 0x1a Build Date */
56 u8 res_0; /* 0x1b Reserved */
57 u32 version; /* 0x1c - 0x1f NXID Version */
58 u8 tempcal[8]; /* 0x20 - 0x27 Temperature Calibration Factors */
59 u8 tempcalsys[2]; /* 0x28 - 0x29 System Temperature Calibration Factors */
60 u8 tempcalflags; /* 0x2a Temperature Calibration Flags */
61 u8 res_1[21]; /* 0x2b - 0x3f Reserved */
62 u8 mac_count; /* 0x40 Number of MAC addresses */
63 u8 mac_flag; /* 0x41 MAC table flags */
64 u8 mac[MAX_NUM_PORTS][6]; /* 0x42 - 0xa1 MAC addresses */
65 u8 res_2[90]; /* 0xa2 - 0xfb Reserved */
66 u32 crc; /* 0xfc - 0xff CRC32 checksum */
70 /* Set to 1 if we've read EEPROM into memory */
71 static int has_been_read = 0;
73 #ifdef CONFIG_SYS_I2C_EEPROM_NXID
74 /* Is this a valid NXID EEPROM? */
75 #define is_valid ((e.id[0] == 'N') || (e.id[1] == 'X') || \
76 (e.id[2] == 'I') || (e.id[3] == 'D'))
79 #ifdef CONFIG_SYS_I2C_EEPROM_CCID
80 /* Is this a valid CCID EEPROM? */
81 #define is_valid ((e.id[0] == 'C') || (e.id[1] == 'C') || \
82 (e.id[2] == 'I') || (e.id[3] == 'D'))
86 * show_eeprom - display the contents of the EEPROM
88 static void show_eeprom(void)
93 /* EEPROM tag ID, either CCID or NXID */
94 #ifdef CONFIG_SYS_I2C_EEPROM_NXID
95 printf("ID: %c%c%c%c v%u\n", e.id[0], e.id[1], e.id[2], e.id[3],
96 be32_to_cpu(e.version));
98 printf("ID: %c%c%c%c\n", e.id[0], e.id[1], e.id[2], e.id[3]);
102 printf("SN: %s\n", e.sn);
105 #ifdef CONFIG_SYS_I2C_EEPROM_NXID
106 printf("Errata: %s\n", e.errata);
108 printf("Errata: %c%c\n",
109 e.errata[0] ? e.errata[0] : '.',
110 e.errata[1] ? e.errata[1] : '.');
113 /* Build date, BCD date values, as YYMMDDhhmmss */
114 printf("Build date: 20%02x/%02x/%02x %02x:%02x:%02x %s\n",
115 e.date[0], e.date[1], e.date[2],
116 e.date[3] & 0x7F, e.date[4], e.date[5],
117 e.date[3] & 0x80 ? "PM" : "");
119 /* Show MAC addresses */
120 for (i = 0; i < min(e.mac_count, (u8)MAX_NUM_PORTS); i++) {
124 printf("Eth%u: %02x:%02x:%02x:%02x:%02x:%02x\n", i,
125 p[0], p[1], p[2], p[3], p[4], p[5]);
128 crc = crc32(0, (void *)&e, sizeof(e) - 4);
130 if (crc == be32_to_cpu(e.crc))
131 printf("CRC: %08x\n", be32_to_cpu(e.crc));
133 printf("CRC: %08x (should be %08x)\n",
134 be32_to_cpu(e.crc), crc);
137 printf("EEPROM dump: (0x%x bytes)\n", sizeof(e));
138 for (i = 0; i < sizeof(e); i++) {
141 printf("%02X ", ((u8 *)&e)[i]);
142 if (((i % 16) == 15) || (i == sizeof(e) - 1))
149 * read_eeprom - read the EEPROM into memory
151 static int read_eeprom(void)
154 #ifdef CONFIG_SYS_EEPROM_BUS_NUM
155 #if !CONFIG_IS_ENABLED(DM_I2C)
163 #ifdef CONFIG_SYS_EEPROM_BUS_NUM
164 #if !CONFIG_IS_ENABLED(DM_I2C)
165 bus = i2c_get_bus_num();
166 i2c_set_bus_num(CONFIG_SYS_EEPROM_BUS_NUM);
170 #if !CONFIG_IS_ENABLED(DM_I2C)
171 ret = i2c_read(CONFIG_SYS_I2C_EEPROM_ADDR, 0,
172 CONFIG_SYS_I2C_EEPROM_ADDR_LEN,
173 (void *)&e, sizeof(e));
176 #ifdef CONFIG_SYS_EEPROM_BUS_NUM
177 ret = i2c_get_chip_for_busnum(CONFIG_SYS_EEPROM_BUS_NUM,
178 CONFIG_SYS_I2C_EEPROM_ADDR,
179 CONFIG_SYS_I2C_EEPROM_ADDR_LEN, &dev);
181 ret = i2c_get_chip_for_busnum(0, CONFIG_SYS_I2C_EEPROM_ADDR,
182 CONFIG_SYS_I2C_EEPROM_ADDR_LEN, &dev);
185 ret = dm_i2c_read(dev, 0, (void *)&e, sizeof(e));
188 #ifdef CONFIG_SYS_EEPROM_BUS_NUM
189 #if !CONFIG_IS_ENABLED(DM_I2C)
190 i2c_set_bus_num(bus);
198 has_been_read = (ret == 0) ? 1 : 0;
204 * update_crc - update the CRC
206 * This function should be called after each update to the EEPROM structure,
207 * to make sure the CRC is always correct.
209 static void update_crc(void)
213 crc = crc32(0, (void *)&e, sizeof(e) - 4);
214 e.crc = cpu_to_be32(crc);
218 * prog_eeprom - write the EEPROM from memory
220 static int prog_eeprom(void)
225 #ifdef CONFIG_SYS_EEPROM_BUS_NUM
226 #if !CONFIG_IS_ENABLED(DM_I2C)
231 /* Set the reserved values to 0xFF */
232 #ifdef CONFIG_SYS_I2C_EEPROM_NXID
234 memset(e.res_1, 0xFF, sizeof(e.res_1));
236 memset(e.res_0, 0xFF, sizeof(e.res_0));
240 #if !CONFIG_IS_ENABLED(DM_I2C)
241 #ifdef CONFIG_SYS_EEPROM_BUS_NUM
242 bus = i2c_get_bus_num();
243 i2c_set_bus_num(CONFIG_SYS_EEPROM_BUS_NUM);
248 * The AT24C02 datasheet says that data can only be written in page
249 * mode, which means 8 bytes at a time, and it takes up to 5ms to
250 * complete a given write.
252 for (i = 0, p = &e; i < sizeof(e); i += 8, p += 8) {
253 #if !CONFIG_IS_ENABLED(DM_I2C)
254 ret = i2c_write(CONFIG_SYS_I2C_EEPROM_ADDR, i,
255 CONFIG_SYS_I2C_EEPROM_ADDR_LEN,
256 p, min((int)(sizeof(e) - i), 8));
259 #ifdef CONFIG_SYS_EEPROM_BUS_NUM
260 ret = i2c_get_chip_for_busnum(CONFIG_SYS_EEPROM_BUS_NUM,
261 CONFIG_SYS_I2C_EEPROM_ADDR,
262 CONFIG_SYS_I2C_EEPROM_ADDR_LEN,
265 ret = i2c_get_chip_for_busnum(0, CONFIG_SYS_I2C_EEPROM_ADDR,
266 CONFIG_SYS_I2C_EEPROM_ADDR_LEN,
270 ret = dm_i2c_write(dev, i, p, min((int)(sizeof(e) - i),
275 udelay(5000); /* 5ms write cycle timing */
279 /* Verify the write by reading back the EEPROM and comparing */
282 #if !CONFIG_IS_ENABLED(DM_I2C)
283 ret = i2c_read(CONFIG_SYS_I2C_EEPROM_ADDR, 0,
284 CONFIG_SYS_I2C_EEPROM_ADDR_LEN,
285 (void *)&e2, sizeof(e2));
288 #ifdef CONFIG_SYS_EEPROM_BUS_NUM
289 ret = i2c_get_chip_for_busnum(CONFIG_SYS_EEPROM_BUS_NUM,
290 CONFIG_SYS_I2C_EEPROM_ADDR,
291 CONFIG_SYS_I2C_EEPROM_ADDR_LEN,
294 ret = i2c_get_chip_for_busnum(0, CONFIG_SYS_I2C_EEPROM_ADDR,
295 CONFIG_SYS_I2C_EEPROM_ADDR_LEN,
299 ret = dm_i2c_read(dev, 0, (void *)&e2, sizeof(e2));
301 if (!ret && memcmp(&e, &e2, sizeof(e)))
305 #if !CONFIG_IS_ENABLED(DM_I2C)
306 #ifdef CONFIG_SYS_EEPROM_BUS_NUM
307 i2c_set_bus_num(bus);
312 printf("Programming failed.\n");
317 printf("Programming passed.\n");
322 * h2i - converts hex character into a number
324 * This function takes a hexadecimal character (e.g. '7' or 'C') and returns
325 * the integer equivalent.
327 static inline u8 h2i(char p)
329 if ((p >= '0') && (p <= '9'))
332 if ((p >= 'A') && (p <= 'F'))
333 return (p - 'A') + 10;
335 if ((p >= 'a') && (p <= 'f'))
336 return (p - 'a') + 10;
342 * set_date - stores the build date into the EEPROM
344 * This function takes a pointer to a string in the format "YYMMDDhhmmss"
345 * (2-digit year, 2-digit month, etc), converts it to a 6-byte BCD string,
346 * and stores it in the build date field of the EEPROM local copy.
348 static void set_date(const char *string)
352 if (strlen(string) != 12) {
353 printf("Usage: mac date YYMMDDhhmmss\n");
357 for (i = 0; i < 6; i++)
358 e.date[i] = h2i(string[2 * i]) << 4 | h2i(string[2 * i + 1]);
364 * set_mac_address - stores a MAC address into the EEPROM
366 * This function takes a pointer to MAC address string
367 * (i.e."XX:XX:XX:XX:XX:XX", where "XX" is a two-digit hex number) and
368 * stores it in one of the MAC address fields of the EEPROM local copy.
370 static void set_mac_address(unsigned int index, const char *string)
372 char *p = (char *) string;
375 if ((index >= MAX_NUM_PORTS) || !string) {
376 printf("Usage: mac <n> XX:XX:XX:XX:XX:XX\n");
380 for (i = 0; *p && (i < 6); i++) {
381 e.mac[index][i] = hextoul(p, &p);
389 int do_mac(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])
406 #ifdef CONFIG_SYS_I2C_EEPROM_NXID
407 memcpy(e.id, "NXID", sizeof(e.id));
408 e.version = cpu_to_be32(NXID_VERSION);
410 memcpy(e.id, "CCID", sizeof(e.id));
417 printf("Please read the EEPROM ('r') and/or set the ID ('i') first.\n");
427 return cmd_usage(cmdtp);
433 /* We know we have at least one parameter */
436 case 'n': /* serial number */
437 memset(e.sn, 0, sizeof(e.sn));
438 strncpy((char *)e.sn, argv[2], sizeof(e.sn) - 1);
441 case 'e': /* errata */
442 #ifdef CONFIG_SYS_I2C_EEPROM_NXID
443 memset(e.errata, 0, 5);
444 strncpy((char *)e.errata, argv[2], 4);
446 e.errata[0] = argv[2][0];
447 e.errata[1] = argv[2][1];
451 case 'd': /* date BCD format YYMMDDhhmmss */
454 case 'p': /* MAC table size */
455 e.mac_count = hextoul(argv[2], NULL);
458 case '0' ... '9': /* "mac 0" through "mac 22" */
459 set_mac_address(dectoul(argv[1], NULL), argv[2]);
463 return cmd_usage(cmdtp);
470 * mac_read_from_eeprom - read the MAC addresses from EEPROM
472 * This function reads the MAC addresses from EEPROM and sets the
473 * appropriate environment variables for each one read.
475 * The environment variables are only set if they haven't been set already.
476 * This ensures that any user-saved variables are never overwritten.
478 * This function must be called after relocation.
480 * For NXID v1 EEPROMs, we support loading and up-converting the older NXID v0
481 * format. In a v0 EEPROM, there are only eight MAC addresses and the CRC is
482 * located at a different offset.
484 int mac_read_from_eeprom(void)
487 u32 crc, crc_offset = offsetof(struct eeprom, crc);
488 u32 *crcp; /* Pointer to the CRC in the data read from the EEPROM */
493 printf("Read failed.\n");
498 printf("Invalid ID (%02x %02x %02x %02x)\n",
499 e.id[0], e.id[1], e.id[2], e.id[3]);
503 #ifdef CONFIG_SYS_I2C_EEPROM_NXID
505 * If we've read an NXID v0 EEPROM, then we need to set the CRC offset
506 * to where it is in v0.
512 crc = crc32(0, (void *)&e, crc_offset);
513 crcp = (void *)&e + crc_offset;
514 if (crc != be32_to_cpu(*crcp)) {
515 printf("CRC mismatch (%08x != %08x)\n", crc, be32_to_cpu(e.crc));
519 #ifdef CONFIG_SYS_I2C_EEPROM_NXID
521 * MAC address #9 in v1 occupies the same position as the CRC in v0.
522 * Erase it so that it's not mistaken for a MAC address. We'll
523 * update the CRC later.
526 memset(e.mac[8], 0xff, 6);
529 for (i = 0; i < min(e.mac_count, (u8)MAX_NUM_PORTS); i++) {
530 if (memcmp(&e.mac[i], "\0\0\0\0\0\0", 6) &&
531 memcmp(&e.mac[i], "\xFF\xFF\xFF\xFF\xFF\xFF", 6)) {
535 sprintf(ethaddr, "%02X:%02X:%02X:%02X:%02X:%02X",
542 sprintf(enetvar, i ? "eth%daddr" : "ethaddr", i);
543 /* Only initialize environment variables that are blank
544 * (i.e. have not yet been set)
546 if (!env_get(enetvar))
547 env_set(enetvar, ethaddr);
551 #ifdef CONFIG_SYS_I2C_EEPROM_NXID
552 printf("%c%c%c%c v%u\n", e.id[0], e.id[1], e.id[2], e.id[3],
553 be32_to_cpu(e.version));
555 printf("%c%c%c%c\n", e.id[0], e.id[1], e.id[2], e.id[3]);
558 #ifdef CONFIG_SYS_I2C_EEPROM_NXID
560 * Now we need to upconvert the data into v1 format. We do this last so
561 * that at boot time, U-Boot will still say "NXID v0".
563 if (e.version == 0) {
564 e.version = cpu_to_be32(NXID_VERSION);
572 #ifdef CONFIG_SYS_I2C_EEPROM_CCID
575 * get_cpu_board_revision - get the CPU board revision on 85xx boards
577 * Read the EEPROM to determine the board revision.
579 * This function is called before relocation, so we need to read a private
580 * copy of the EEPROM into a local variable on the stack.
582 * Also, we assume that CONFIG_SYS_EEPROM_BUS_NUM == CONFIG_SYS_SPD_BUS_NUM. The global
583 * variable i2c_bus_num must be compile-time initialized to CONFIG_SYS_SPD_BUS_NUM,
584 * so that the SPD code will work. This means that all pre-relocation I2C
585 * operations can only occur on the CONFIG_SYS_SPD_BUS_NUM bus. So if
586 * CONFIG_SYS_EEPROM_BUS_NUM != CONFIG_SYS_SPD_BUS_NUM, then we can't read the EEPROM when
587 * this function is called. Oh well.
589 unsigned int get_cpu_board_revision(void)
591 struct board_eeprom {
592 u32 id; /* 0x00 - 0x03 EEPROM Tag 'CCID' */
593 u8 major; /* 0x04 Board revision, major */
594 u8 minor; /* 0x05 Board revision, minor */
597 #if !CONFIG_IS_ENABLED(DM_I2C)
598 i2c_read(CONFIG_SYS_I2C_EEPROM_ADDR, 0, CONFIG_SYS_I2C_EEPROM_ADDR_LEN,
599 (void *)&be, sizeof(be));
603 #ifdef CONFIG_SYS_EEPROM_BUS_NUM
604 ret = i2c_get_chip_for_busnum(CONFIG_SYS_EEPROM_BUS_NUM,
605 CONFIG_SYS_I2C_EEPROM_ADDR,
606 CONFIG_SYS_I2C_EEPROM_ADDR_LEN,
609 ret = i2c_get_chip_for_busnum(0, CONFIG_SYS_I2C_EEPROM_ADDR,
610 CONFIG_SYS_I2C_EEPROM_ADDR_LEN,
614 dm_i2c_read(dev, 0, (void *)&be, sizeof(be));
617 if (be.id != (('C' << 24) | ('C' << 16) | ('I' << 8) | 'D'))
618 return MPC85XX_CPU_BOARD_REV(0, 0);
620 if ((be.major == 0xff) && (be.minor == 0xff))
621 return MPC85XX_CPU_BOARD_REV(0, 0);
623 return MPC85XX_CPU_BOARD_REV(be.major, be.minor);