[people/ms/u-boot.git] / board / freescale / common / sys_eeprom.c

/*
 * Copyright 2006, 2008-2009 Freescale Semiconductor
 * York Sun (yorksun@freescale.com)
 * Haiying Wang (haiying.wang@freescale.com)
 * Timur Tabi (timur@freescale.com)
 *
 * See file CREDITS for list of people who contributed to this
 * project.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of
 * the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 * MA 02111-1307 USA
 */

#include <common.h>
#include <command.h>
#include <i2c.h>
#include <linux/ctype.h>

#include "../common/eeprom.h"

#if !defined(CONFIG_SYS_I2C_EEPROM_CCID) && !defined(CONFIG_SYS_I2C_EEPROM_NXID)
#error "Please define either CONFIG_SYS_I2C_EEPROM_CCID or CONFIG_SYS_I2C_EEPROM_NXID"
#endif

#define MAX_NUM_PORTS	8	/* This value must be 8 as defined in doc */

/**
 * static eeprom: EEPROM layout for CCID or NXID formats
 *
 * See application note AN3638 for details.
 */
static struct __attribute__ ((__packed__)) eeprom {
#ifdef CONFIG_SYS_I2C_EEPROM_CCID
	u8 id[4];         /* 0x00 - 0x03 EEPROM Tag 'CCID' */
	u8 major;         /* 0x04        Board revision, major */
	u8 minor;         /* 0x05        Board revision, minor */
	u8 sn[10];        /* 0x06 - 0x0F Serial Number*/
	u8 errata[2];     /* 0x10 - 0x11 Errata Level */
	u8 date[6];       /* 0x12 - 0x17 Build Date */
	u8 res_0[40];     /* 0x18 - 0x3f Reserved */
	u8 mac_count;     /* 0x40        Number of MAC addresses */
	u8 mac_flag;      /* 0x41        MAC table flags */
	u8 mac[MAX_NUM_PORTS][6];     /* 0x42 - 0x71 MAC addresses */
	u32 crc;          /* 0x72        CRC32 checksum */
#endif
#ifdef CONFIG_SYS_I2C_EEPROM_NXID
	u8 id[4];         /* 0x00 - 0x03 EEPROM Tag 'NXID' */
	u8 sn[12];        /* 0x04 - 0x0F Serial Number */
	u8 errata[5];     /* 0x10 - 0x14 Errata Level */
	u8 date[6];       /* 0x15 - 0x1a Build Date */
	u8 res_0;         /* 0x1b        Reserved */
	u32 version;      /* 0x1c - 0x1f NXID Version */
	u8 tempcal[8];    /* 0x20 - 0x27 Temperature Calibration Factors */
	u8 tempcalsys[2]; /* 0x28 - 0x29 System Temperature Calibration Factors */
	u8 tempcalflags;  /* 0x2a        Temperature Calibration Flags */
	u8 res_1[21];     /* 0x2b - 0x3f Reserved */
	u8 mac_count;     /* 0x40        Number of MAC addresses */
	u8 mac_flag;      /* 0x41        MAC table flags */
	u8 mac[MAX_NUM_PORTS][6];     /* 0x42 - 0x71 MAC addresses */
	u32 crc;          /* 0x72        CRC32 checksum */
#endif
} e;

/* Set to 1 if we've read EEPROM into memory */
static int has_been_read = 0;

#ifdef CONFIG_SYS_I2C_EEPROM_NXID
/* Is this a valid NXID EEPROM? */
#define is_valid ((e.id[0] == 'N') || (e.id[1] == 'X') || \
		  (e.id[2] == 'I') || (e.id[3] == 'D'))
#endif

#ifdef CONFIG_SYS_I2C_EEPROM_CCID
/* Is this a valid CCID EEPROM? */
#define is_valid ((e.id[0] == 'C') || (e.id[1] == 'C') || \
		  (e.id[2] == 'I') || (e.id[3] == 'D'))
#endif

/**
 * show_eeprom - display the contents of the EEPROM
 */
static void show_eeprom(void)
{
	int i;
	unsigned int crc;

	/* EEPROM tag ID, either CCID or NXID */
#ifdef CONFIG_SYS_I2C_EEPROM_NXID
	printf("ID: %c%c%c%c v%u\n", e.id[0], e.id[1], e.id[2], e.id[3],
		be32_to_cpu(e.version));
#else
	printf("ID: %c%c%c%c\n", e.id[0], e.id[1], e.id[2], e.id[3]);
#endif

	/* Serial number */
	printf("SN: %s\n", e.sn);

	/* Errata level. */
#ifdef CONFIG_SYS_I2C_EEPROM_NXID
	printf("Errata: %s\n", e.errata);
#else
	printf("Errata: %c%c\n",
		e.errata[0] ? e.errata[0] : '.',
		e.errata[1] ? e.errata[1] : '.');
#endif

	/* Build date, BCD date values, as YYMMDDhhmmss */
	printf("Build date: 20%02x/%02x/%02x %02x:%02x:%02x %s\n",
		e.date[0], e.date[1], e.date[2],
		e.date[3] & 0x7F, e.date[4], e.date[5],
		e.date[3] & 0x80 ? "PM" : "");

	/* Show MAC addresses  */
	for (i = 0; i < min(e.mac_count, MAX_NUM_PORTS); i++) {

		u8 *p = e.mac[i];

		printf("Eth%u: %02x:%02x:%02x:%02x:%02x:%02x\n", i,
			p[0], p[1], p[2], p[3],	p[4], p[5]);
	}

	crc = crc32(0, (void *)&e, sizeof(e) - 4);

	if (crc == be32_to_cpu(e.crc))
		printf("CRC: %08x\n", be32_to_cpu(e.crc));
	else
		printf("CRC: %08x (should be %08x)\n",
			be32_to_cpu(e.crc), crc);

#ifdef DEBUG
	printf("EEPROM dump: (0x%x bytes)\n", sizeof(e));
	for (i = 0; i < sizeof(e); i++) {
		if ((i % 16) == 0)
			printf("%02X: ", i);
		printf("%02X ", ((u8 *)&e)[i]);
		if (((i % 16) == 15) || (i == sizeof(e) - 1))
			printf("\n");
	}
#endif
}

/**
 * read_eeprom - read the EEPROM into memory
 */
static int read_eeprom(void)
{
	int ret;
#ifdef CONFIG_SYS_EEPROM_BUS_NUM
	unsigned int bus;
#endif

	if (has_been_read)
		return 0;

#ifdef CONFIG_SYS_EEPROM_BUS_NUM
	bus = i2c_get_bus_num();
	i2c_set_bus_num(CONFIG_SYS_EEPROM_BUS_NUM);
#endif

	ret = i2c_read(CONFIG_SYS_I2C_EEPROM_ADDR, 0, CONFIG_SYS_I2C_EEPROM_ADDR_LEN,
		(void *)&e, sizeof(e));

#ifdef CONFIG_SYS_EEPROM_BUS_NUM
	i2c_set_bus_num(bus);
#endif

#ifdef DEBUG
	show_eeprom();
#endif

	has_been_read = (ret == 0) ? 1 : 0;

	return ret;
}

/**
 *  update_crc - update the CRC
 *
 *  This function should be called after each update to the EEPROM structure,
 *  to make sure the CRC is always correct.
 */
static void update_crc(void)
{
	u32 crc;

	crc = crc32(0, (void *)&e, sizeof(e) - 4);
	e.crc = cpu_to_be32(crc);
}

/**
 * prog_eeprom - write the EEPROM from memory
 */
static int prog_eeprom(void)
{
	int ret = 0; /* shut up gcc */
	int i;
	void *p;
#ifdef CONFIG_SYS_EEPROM_BUS_NUM
	unsigned int bus;
#endif

	/* Set the reserved values to 0xFF   */
#ifdef CONFIG_SYS_I2C_EEPROM_NXID
	e.res_0 = 0xFF;
	memset(e.res_1, 0xFF, sizeof(e.res_1));
#else
	memset(e.res_0, 0xFF, sizeof(e.res_0));
#endif
	update_crc();

#ifdef CONFIG_SYS_EEPROM_BUS_NUM
	bus = i2c_get_bus_num();
	i2c_set_bus_num(CONFIG_SYS_EEPROM_BUS_NUM);
#endif

	for (i = 0, p = &e; i < sizeof(e); i += 8, p += 8) {
		ret = i2c_write(CONFIG_SYS_I2C_EEPROM_ADDR, i, CONFIG_SYS_I2C_EEPROM_ADDR_LEN,
			p, min((sizeof(e) - i), 8));
		if (ret)
			break;
		udelay(5000);	/* 5ms write cycle timing */
	}

#ifdef CONFIG_SYS_EEPROM_BUS_NUM
	i2c_set_bus_num(bus);
#endif

	if (ret) {
		printf("Programming failed.\n");
		return -1;
	}

	printf("Programming passed.\n");
	return 0;
}

/**
 * h2i - converts hex character into a number
 *
 * This function takes a hexadecimal character (e.g. '7' or 'C') and returns
 * the integer equivalent.
 */
static inline u8 h2i(char p)
{
	if ((p >= '0') && (p <= '9'))
		return p - '0';

	if ((p >= 'A') && (p <= 'F'))
		return (p - 'A') + 10;

	if ((p >= 'a') && (p <= 'f'))
		return (p - 'a') + 10;

	return 0;
}

/**
 * set_date - stores the build date into the EEPROM
 *
 * This function takes a pointer to a string in the format "YYMMDDhhmmss"
 * (2-digit year, 2-digit month, etc), converts it to a 6-byte BCD string,
 * and stores it in the build date field of the EEPROM local copy.
 */
static void set_date(const char *string)
{
	unsigned int i;

	if (strlen(string) != 12) {
		printf("Usage: mac date YYMMDDhhmmss\n");
		return;
	}

	for (i = 0; i < 6; i++)
		e.date[i] = h2i(string[2 * i]) << 4 | h2i(string[2 * i + 1]);

	update_crc();
}

/**
 * set_mac_address - stores a MAC address into the EEPROM
 *
 * This function takes a pointer to MAC address string
 * (i.e."XX:XX:XX:XX:XX:XX", where "XX" is a two-digit hex number) and
 * stores it in one of the MAC address fields of the EEPROM local copy.
 */
static void set_mac_address(unsigned int index, const char *string)
{
	char *p = (char *) string;
	unsigned int i;

	if (!string) {
		printf("Usage: mac <n> XX:XX:XX:XX:XX:XX\n");
		return;
	}

	for (i = 0; *p && (i < 6); i++) {
		e.mac[index][i] = simple_strtoul(p, &p, 16);
		if (*p == ':')
			p++;
	}

	update_crc();
}

int do_mac(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
{
	char cmd;

	if (argc == 1) {
		show_eeprom();
		return 0;
	}

	cmd = argv[1][0];

	if (cmd == 'r') {
		read_eeprom();
		return 0;
	}

	if (cmd == 'i') {
#ifdef CONFIG_SYS_I2C_EEPROM_NXID
		memcpy(e.id, "NXID", sizeof(e.id));
		e.version = 0;
#else
		memcpy(e.id, "CCID", sizeof(e.id));
#endif
		return 0;
	}

	if (!is_valid) {
		printf("Please read the EEPROM ('r') and/or set the ID ('i') first.\n");
		return 0;
	}

	if (argc == 2) {
		switch (cmd) {
		case 's':	/* save */
			prog_eeprom();
			break;
		default:
			return cmd_usage(cmdtp);
		}

		return 0;
	}

	/* We know we have at least one parameter  */

	switch (cmd) {
	case 'n':	/* serial number */
		memset(e.sn, 0, sizeof(e.sn));
		strncpy((char *)e.sn, argv[2], sizeof(e.sn) - 1);
		update_crc();
		break;
	case 'e':	/* errata */
#ifdef CONFIG_SYS_I2C_EEPROM_NXID
		memset(e.errata, 0, 5);
		strncpy((char *)e.errata, argv[2], 4);
#else
		e.errata[0] = argv[2][0];
		e.errata[1] = argv[2][1];
#endif
		update_crc();
		break;
	case 'd':	/* date BCD format YYMMDDhhmmss */
		set_date(argv[2]);
		break;
	case 'p':	/* MAC table size */
		e.mac_count = simple_strtoul(argv[2], NULL, 16);
		update_crc();
		break;
	case '0' ... '7':	/* "mac 0" through "mac 7" */
		set_mac_address(cmd - '0', argv[2]);
		break;
	case 'h':	/* help */
	default:
		return cmd_usage(cmdtp);
	}

	return 0;
}

/**
 * mac_read_from_eeprom - read the MAC addresses from EEPROM
 *
 * This function reads the MAC addresses from EEPROM and sets the
 * appropriate environment variables for each one read.
 *
 * The environment variables are only set if they haven't been set already.
 * This ensures that any user-saved variables are never overwritten.
 *
 * This function must be called after relocation.
 */
int mac_read_from_eeprom(void)
{
	unsigned int i;
	u32 crc;

	puts("EEPROM: ");

	if (read_eeprom()) {
		printf("Read failed.\n");
		return -1;
	}

	if (!is_valid) {
		printf("Invalid ID (%02x %02x %02x %02x)\n",
		       e.id[0], e.id[1], e.id[2], e.id[3]);
		return -1;
	}

	crc = crc32(0, (void *)&e, sizeof(e) - 4);
	if (crc != be32_to_cpu(e.crc)) {
		printf("CRC mismatch (%08x != %08x)\n", crc, be32_to_cpu(e.crc));
		return -1;
	}

	for (i = 0; i < min(e.mac_count, MAX_NUM_PORTS); i++) {
		if (memcmp(&e.mac[i], "\0\0\0\0\0\0", 6) &&
		    memcmp(&e.mac[i], "\xFF\xFF\xFF\xFF\xFF\xFF", 6)) {
			char ethaddr[18];
			char enetvar[9];

			sprintf(ethaddr, "%02X:%02X:%02X:%02X:%02X:%02X",
				e.mac[i][0],
				e.mac[i][1],
				e.mac[i][2],
				e.mac[i][3],
				e.mac[i][4],
				e.mac[i][5]);
			sprintf(enetvar, i ? "eth%daddr" : "ethaddr", i);
			/* Only initialize environment variables that are blank
			 * (i.e. have not yet been set)
			 */
			if (!getenv(enetvar))
				setenv(enetvar, ethaddr);
		}
	}

#ifdef CONFIG_SYS_I2C_EEPROM_NXID
	printf("%c%c%c%c v%u\n", e.id[0], e.id[1], e.id[2], e.id[3],
		be32_to_cpu(e.version));
#else
	printf("%c%c%c%c\n", e.id[0], e.id[1], e.id[2], e.id[3]);
#endif

	return 0;
}

#ifdef CONFIG_SYS_I2C_EEPROM_CCID

/**
 * get_cpu_board_revision - get the CPU board revision on 85xx boards
 *
 * Read the EEPROM to determine the board revision.
 *
 * This function is called before relocation, so we need to read a private
 * copy of the EEPROM into a local variable on the stack.
 *
 * Also, we assume that CONFIG_SYS_EEPROM_BUS_NUM == CONFIG_SYS_SPD_BUS_NUM.  The global
 * variable i2c_bus_num must be compile-time initialized to CONFIG_SYS_SPD_BUS_NUM,
 * so that the SPD code will work.  This means that all pre-relocation I2C
 * operations can only occur on the CONFIG_SYS_SPD_BUS_NUM bus.  So if
 * CONFIG_SYS_EEPROM_BUS_NUM != CONFIG_SYS_SPD_BUS_NUM, then we can't read the EEPROM when
 * this function is called.  Oh well.
 */
unsigned int get_cpu_board_revision(void)
{
	struct board_eeprom {
		u32 id;           /* 0x00 - 0x03 EEPROM Tag 'CCID' */
		u8 major;         /* 0x04        Board revision, major */
		u8 minor;         /* 0x05        Board revision, minor */
	} be;

	i2c_read(CONFIG_SYS_I2C_EEPROM_ADDR, 0, CONFIG_SYS_I2C_EEPROM_ADDR_LEN,
		(void *)&be, sizeof(be));

	if (be.id != (('C' << 24) | ('C' << 16) | ('I' << 8) | 'D'))
		return MPC85XX_CPU_BOARD_REV(0, 0);

	if ((be.major == 0xff) && (be.minor == 0xff))
		return MPC85XX_CPU_BOARD_REV(0, 0);

	return MPC85XX_CPU_BOARD_REV(be.major, be.minor);
}
#endif
Commit	Line	Data
bea3f28d	1	/*
9a611089	2	* Copyright 2006, 2008-2009 Freescale Semiconductor
bea3f28d HW	3	* York Sun (yorksun@freescale.com)
bea3f28d HW	4	* Haiying Wang (haiying.wang@freescale.com)
e2d31fb3	5	* Timur Tabi (timur@freescale.com)
bea3f28d HW	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
e2d31fb3 TT	31	#include "../common/eeprom.h"
e2d31fb3 TT	32
6d0f6bcf JCPV	33	#if !defined(CONFIG_SYS_I2C_EEPROM_CCID) && !defined(CONFIG_SYS_I2C_EEPROM_NXID)
6d0f6bcf JCPV	34	#error "Please define either CONFIG_SYS_I2C_EEPROM_CCID or CONFIG_SYS_I2C_EEPROM_NXID"
e2d31fb3 TT	35	#endif
e2d31fb3 TT	36
9a611089 HW	37	#define MAX_NUM_PORTS 8 /* This value must be 8 as defined in doc */
9a611089 HW	38
e2d31fb3 TT	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 {
6d0f6bcf	45	#ifdef CONFIG_SYS_I2C_EEPROM_CCID
e2d31fb3 TT	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 */
9a611089	55	u8 mac[MAX_NUM_PORTS][6]; /* 0x42 - 0x71 MAC addresses */
e2d31fb3 TT	56	u32 crc; /* 0x72 CRC32 checksum */
e2d31fb3 TT	57	#endif
6d0f6bcf	58	#ifdef CONFIG_SYS_I2C_EEPROM_NXID
e2d31fb3 TT	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 */
9a611089	71	u8 mac[MAX_NUM_PORTS][6]; /* 0x42 - 0x71 MAC addresses */
e2d31fb3 TT	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
6d0f6bcf	79	#ifdef CONFIG_SYS_I2C_EEPROM_NXID
e2d31fb3	80	/* Is this a valid NXID EEPROM? */
afb0b131 KG	81	#define is_valid ((e.id[0] == 'N') \|\| (e.id[1] == 'X') \|\| \
afb0b131 KG	82	(e.id[2] == 'I') \|\| (e.id[3] == 'D'))
e2d31fb3 TT	83	#endif
e2d31fb3 TT	84
6d0f6bcf	85	#ifdef CONFIG_SYS_I2C_EEPROM_CCID
e2d31fb3	86	/* Is this a valid CCID EEPROM? */
afb0b131 KG	87	#define is_valid ((e.id[0] == 'C') \|\| (e.id[1] == 'C') \|\| \
afb0b131 KG	88	(e.id[2] == 'I') \|\| (e.id[3] == 'D'))
e2d31fb3 TT	89	#endif
	90
	91	/**
	92	* show_eeprom - display the contents of the EEPROM
	93	*/
	94	static void show_eeprom(void)
bea3f28d HW	95	{
bea3f28d HW	96	int i;
e2d31fb3 TT	97	unsigned int crc;
	98
	99	/* EEPROM tag ID, either CCID or NXID */
6d0f6bcf	100	#ifdef CONFIG_SYS_I2C_EEPROM_NXID
e2d31fb3 TT	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));
	103	#else
	104	printf("ID: %c%c%c%c\n", e.id[0], e.id[1], e.id[2], e.id[3]);
	105	#endif
	106
	107	/* Serial number */
	108	printf("SN: %s\n", e.sn);
	109
	110	/* Errata level. */
6d0f6bcf	111	#ifdef CONFIG_SYS_I2C_EEPROM_NXID
e2d31fb3 TT	112	printf("Errata: %s\n", e.errata);
	113	#else
	114	printf("Errata: %c%c\n",
	115	e.errata[0] ? e.errata[0] : '.',
	116	e.errata[1] ? e.errata[1] : '.');
	117	#endif
	118
	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" : "");
	124
	125	/* Show MAC addresses */
9a611089 HW	126	for (i = 0; i < min(e.mac_count, MAX_NUM_PORTS); i++) {
9a611089 HW	127
e2d31fb3	128	u8 *p = e.mac[i];
d59feffb	129
e2d31fb3 TT	130	printf("Eth%u: %02x:%02x:%02x:%02x:%02x:%02x\n", i,
e2d31fb3 TT	131	p[0], p[1], p[2], p[3], p[4], p[5]);
d59feffb	132	}
bea3f28d	133
e2d31fb3 TT	134	crc = crc32(0, (void *)&e, sizeof(e) - 4);
	135
	136	if (crc == be32_to_cpu(e.crc))
	137	printf("CRC: %08x\n", be32_to_cpu(e.crc));
	138	else
	139	printf("CRC: %08x (should be %08x)\n",
	140	be32_to_cpu(e.crc), crc);
	141
	142	#ifdef DEBUG
	143	printf("EEPROM dump: (0x%x bytes)\n", sizeof(e));
	144	for (i = 0; i < sizeof(e); i++) {
	145	if ((i % 16) == 0)
	146	printf("%02X: ", i);
	147	printf("%02X ", ((u8 *)&e)[i]);
	148	if (((i % 16) == 15) \|\| (i == sizeof(e) - 1))
	149	printf("\n");
	150	}
	151	#endif
bea3f28d HW	152	}
bea3f28d HW	153
e2d31fb3 TT	154	/**
	155	* read_eeprom - read the EEPROM into memory
	156	*/
	157	static int read_eeprom(void)
bea3f28d	158	{
e2d31fb3	159	int ret;
6d0f6bcf	160	#ifdef CONFIG_SYS_EEPROM_BUS_NUM
e2d31fb3 TT	161	unsigned int bus;
e2d31fb3 TT	162	#endif
bea3f28d	163
e2d31fb3 TT	164	if (has_been_read)
e2d31fb3 TT	165	return 0;
bea3f28d	166
6d0f6bcf	167	#ifdef CONFIG_SYS_EEPROM_BUS_NUM
e2d31fb3	168	bus = i2c_get_bus_num();
6d0f6bcf	169	i2c_set_bus_num(CONFIG_SYS_EEPROM_BUS_NUM);
e2d31fb3 TT	170	#endif
e2d31fb3 TT	171
6d0f6bcf	172	ret = i2c_read(CONFIG_SYS_I2C_EEPROM_ADDR, 0, CONFIG_SYS_I2C_EEPROM_ADDR_LEN,
e2d31fb3 TT	173	(void *)&e, sizeof(e));
e2d31fb3 TT	174
6d0f6bcf	175	#ifdef CONFIG_SYS_EEPROM_BUS_NUM
e2d31fb3 TT	176	i2c_set_bus_num(bus);
	177	#endif
	178
	179	#ifdef DEBUG
	180	show_eeprom();
	181	#endif
	182
	183	has_been_read = (ret == 0) ? 1 : 0;
	184
	185	return ret;
bea3f28d HW	186	}
bea3f28d HW	187
2d04db08 TT	188	/**
	189	* update_crc - update the CRC
	190	*
	191	* This function should be called after each update to the EEPROM structure,
	192	* to make sure the CRC is always correct.
	193	*/
	194	static void update_crc(void)
	195	{
	196	u32 crc;
	197
	198	crc = crc32(0, (void *)&e, sizeof(e) - 4);
	199	e.crc = cpu_to_be32(crc);
	200	}
	201
e2d31fb3 TT	202	/**
	203	* prog_eeprom - write the EEPROM from memory
	204	*/
	205	static int prog_eeprom(void)
bea3f28d	206	{
9c671e70 AV	207	int ret = 0; /* shut up gcc */
9c671e70 AV	208	int i;
e2d31fb3	209	void *p;
6d0f6bcf	210	#ifdef CONFIG_SYS_EEPROM_BUS_NUM
e2d31fb3 TT	211	unsigned int bus;
	212	#endif
	213
	214	/* Set the reserved values to 0xFF */
6d0f6bcf	215	#ifdef CONFIG_SYS_I2C_EEPROM_NXID
e2d31fb3 TT	216	e.res_0 = 0xFF;
	217	memset(e.res_1, 0xFF, sizeof(e.res_1));
	218	#else
	219	memset(e.res_0, 0xFF, sizeof(e.res_0));
	220	#endif
2d04db08	221	update_crc();
e2d31fb3	222
6d0f6bcf	223	#ifdef CONFIG_SYS_EEPROM_BUS_NUM
e2d31fb3	224	bus = i2c_get_bus_num();
6d0f6bcf	225	i2c_set_bus_num(CONFIG_SYS_EEPROM_BUS_NUM);
e2d31fb3 TT	226	#endif
e2d31fb3 TT	227
2d04db08	228	for (i = 0, p = &e; i < sizeof(e); i += 8, p += 8) {
6d0f6bcf	229	ret = i2c_write(CONFIG_SYS_I2C_EEPROM_ADDR, i, CONFIG_SYS_I2C_EEPROM_ADDR_LEN,
2d04db08	230	p, min((sizeof(e) - i), 8));
bea3f28d HW	231	if (ret)
bea3f28d HW	232	break;
e2d31fb3	233	udelay(5000); /* 5ms write cycle timing */
bea3f28d	234	}
e2d31fb3	235
6d0f6bcf	236	#ifdef CONFIG_SYS_EEPROM_BUS_NUM
e2d31fb3 TT	237	i2c_set_bus_num(bus);
	238	#endif
	239
bea3f28d HW	240	if (ret) {
	241	printf("Programming failed.\n");
	242	return -1;
bea3f28d	243	}
e2d31fb3 TT	244
e2d31fb3 TT	245	printf("Programming passed.\n");
bea3f28d HW	246	return 0;
	247	}
	248
e2d31fb3 TT	249	/**
	250	* h2i - converts hex character into a number
	251	*
	252	* This function takes a hexadecimal character (e.g. '7' or 'C') and returns
	253	* the integer equivalent.
	254	*/
	255	static inline u8 h2i(char p)
	256	{
	257	if ((p >= '0') && (p <= '9'))
	258	return p - '0';
	259
	260	if ((p >= 'A') && (p <= 'F'))
	261	return (p - 'A') + 10;
	262
	263	if ((p >= 'a') && (p <= 'f'))
	264	return (p - 'a') + 10;
	265
	266	return 0;
	267	}
	268
	269	/**
	270	* set_date - stores the build date into the EEPROM
	271	*
	272	* This function takes a pointer to a string in the format "YYMMDDhhmmss"
	273	* (2-digit year, 2-digit month, etc), converts it to a 6-byte BCD string,
	274	* and stores it in the build date field of the EEPROM local copy.
	275	*/
	276	static void set_date(const char *string)
	277	{
	278	unsigned int i;
	279
	280	if (strlen(string) != 12) {
	281	printf("Usage: mac date YYMMDDhhmmss\n");
	282	return;
	283	}
	284
	285	for (i = 0; i < 6; i++)
	286	e.date[i] = h2i(string[2 * i]) << 4 \| h2i(string[2 * i + 1]);
2d04db08 TT	287
2d04db08 TT	288	update_crc();
e2d31fb3 TT	289	}
	290
	291	/**
	292	* set_mac_address - stores a MAC address into the EEPROM
	293	*
	294	* This function takes a pointer to MAC address string
	295	* (i.e."XX:XX:XX:XX:XX:XX", where "XX" is a two-digit hex number) and
	296	* stores it in one of the MAC address fields of the EEPROM local copy.
	297	*/
	298	static void set_mac_address(unsigned int index, const char *string)
	299	{
	300	char p = (char ) string;
	301	unsigned int i;
	302
	303	if (!string) {
	304	printf("Usage: mac <n> XX:XX:XX:XX:XX:XX\n");
	305	return;
	306	}
	307
	308	for (i = 0; *p && (i < 6); i++) {
	309	e.mac[index][i] = simple_strtoul(p, &p, 16);
	310	if (*p == ':')
	311	p++;
	312	}
2d04db08 TT	313
2d04db08 TT	314	update_crc();
e2d31fb3 TT	315	}
e2d31fb3 TT	316
54841ab5	317	int do_mac(cmd_tbl_t cmdtp, int flag, int argc, char const argv[])
bea3f28d	318	{
e2d31fb3	319	char cmd;
bea3f28d	320
e2d31fb3 TT	321	if (argc == 1) {
	322	show_eeprom();
	323	return 0;
	324	}
	325
	326	cmd = argv[1][0];
	327
	328	if (cmd == 'r') {
	329	read_eeprom();
	330	return 0;
	331	}
bea3f28d	332
2d04db08 TT	333	if (cmd == 'i') {
	334	#ifdef CONFIG_SYS_I2C_EEPROM_NXID
	335	memcpy(e.id, "NXID", sizeof(e.id));
	336	e.version = 0;
	337	#else
	338	memcpy(e.id, "CCID", sizeof(e.id));
	339	#endif
e2d31fb3 TT	340	return 0;
	341	}
	342
	343	if (!is_valid) {
	344	printf("Please read the EEPROM ('r') and/or set the ID ('i') first.\n");
	345	return 0;
	346	}
	347
	348	if (argc == 2) {
bea3f28d	349	switch (cmd) {
80e955c7	350	case 's': /* save */
e2d31fb3	351	prog_eeprom();
80e955c7	352	break;
80e955c7	353	default:
47e26b1b	354	return cmd_usage(cmdtp);
bea3f28d	355	}
e2d31fb3 TT	356
	357	return 0;
	358	}
	359
	360	/* We know we have at least one parameter */
	361
	362	switch (cmd) {
	363	case 'n': /* serial number */
	364	memset(e.sn, 0, sizeof(e.sn));
	365	strncpy((char *)e.sn, argv[2], sizeof(e.sn) - 1);
2d04db08	366	update_crc();
e2d31fb3 TT	367	break;
e2d31fb3 TT	368	case 'e': /* errata */
6d0f6bcf	369	#ifdef CONFIG_SYS_I2C_EEPROM_NXID
e2d31fb3 TT	370	memset(e.errata, 0, 5);
	371	strncpy((char *)e.errata, argv[2], 4);
	372	#else
	373	e.errata[0] = argv[2][0];
	374	e.errata[1] = argv[2][1];
	375	#endif
2d04db08	376	update_crc();
e2d31fb3 TT	377	break;
	378	case 'd': /* date BCD format YYMMDDhhmmss */
	379	set_date(argv[2]);
	380	break;
	381	case 'p': /* MAC table size */
	382	e.mac_count = simple_strtoul(argv[2], NULL, 16);
2d04db08	383	update_crc();
e2d31fb3 TT	384	break;
	385	case '0' ... '7': /* "mac 0" through "mac 7" */
	386	set_mac_address(cmd - '0', argv[2]);
	387	break;
	388	case 'h': /* help */
	389	default:
47e26b1b	390	return cmd_usage(cmdtp);
bea3f28d	391	}
e2d31fb3	392
bea3f28d HW	393	return 0;
	394	}
	395
e2d31fb3 TT	396	/**
	397	* mac_read_from_eeprom - read the MAC addresses from EEPROM
	398	*
	399	* This function reads the MAC addresses from EEPROM and sets the
	400	* appropriate environment variables for each one read.
	401	*
	402	* The environment variables are only set if they haven't been set already.
	403	* This ensures that any user-saved variables are never overwritten.
	404	*
	405	* This function must be called after relocation.
	406	*/
bea3f28d HW	407	int mac_read_from_eeprom(void)
bea3f28d HW	408	{
e2d31fb3	409	unsigned int i;
2d04db08 TT	410	u32 crc;
	411
	412	puts("EEPROM: ");
e2d31fb3 TT	413
e2d31fb3 TT	414	if (read_eeprom()) {
bea3f28d HW	415	printf("Read failed.\n");
	416	return -1;
	417	}
	418
e2d31fb3	419	if (!is_valid) {
2d04db08 TT	420	printf("Invalid ID (%02x %02x %02x %02x)\n",
2d04db08 TT	421	e.id[0], e.id[1], e.id[2], e.id[3]);
bea3f28d	422	return -1;
e2d31fb3 TT	423	}
e2d31fb3 TT	424
2d04db08 TT	425	crc = crc32(0, (void *)&e, sizeof(e) - 4);
	426	if (crc != be32_to_cpu(e.crc)) {
	427	printf("CRC mismatch (%08x != %08x)\n", crc, be32_to_cpu(e.crc));
	428	return -1;
9a611089 HW	429	}
9a611089 HW	430
2d04db08	431	for (i = 0; i < min(e.mac_count, MAX_NUM_PORTS); i++) {
e2d31fb3 TT	432	if (memcmp(&e.mac[i], "\0\0\0\0\0\0", 6) &&
	433	memcmp(&e.mac[i], "\xFF\xFF\xFF\xFF\xFF\xFF", 6)) {
	434	char ethaddr[18];
	435	char enetvar[9];
	436
	437	sprintf(ethaddr, "%02X:%02X:%02X:%02X:%02X:%02X",
	438	e.mac[i][0],
	439	e.mac[i][1],
	440	e.mac[i][2],
	441	e.mac[i][3],
	442	e.mac[i][4],
	443	e.mac[i][5]);
	444	sprintf(enetvar, i ? "eth%daddr" : "ethaddr", i);
	445	/* Only initialize environment variables that are blank
	446	* (i.e. have not yet been set)
	447	*/
	448	if (!getenv(enetvar))
	449	setenv(enetvar, ethaddr);
	450	}
	451	}
	452
2d04db08 TT	453	#ifdef CONFIG_SYS_I2C_EEPROM_NXID
	454	printf("%c%c%c%c v%u\n", e.id[0], e.id[1], e.id[2], e.id[3],
	455	be32_to_cpu(e.version));
	456	#else
	457	printf("%c%c%c%c\n", e.id[0], e.id[1], e.id[2], e.id[3]);
	458	#endif
	459
bea3f28d HW	460	return 0;
bea3f28d HW	461	}
e2d31fb3	462
6d0f6bcf	463	#ifdef CONFIG_SYS_I2C_EEPROM_CCID
e2d31fb3 TT	464
	465	/**
	466	* get_cpu_board_revision - get the CPU board revision on 85xx boards
	467	*
	468	* Read the EEPROM to determine the board revision.
	469	*
	470	* This function is called before relocation, so we need to read a private
	471	* copy of the EEPROM into a local variable on the stack.
	472	*
6d0f6bcf JCPV	473	* Also, we assume that CONFIG_SYS_EEPROM_BUS_NUM == CONFIG_SYS_SPD_BUS_NUM. The global
6d0f6bcf JCPV	474	* variable i2c_bus_num must be compile-time initialized to CONFIG_SYS_SPD_BUS_NUM,
e2d31fb3	475	* so that the SPD code will work. This means that all pre-relocation I2C
6d0f6bcf JCPV	476	* operations can only occur on the CONFIG_SYS_SPD_BUS_NUM bus. So if
6d0f6bcf JCPV	477	* CONFIG_SYS_EEPROM_BUS_NUM != CONFIG_SYS_SPD_BUS_NUM, then we can't read the EEPROM when
e2d31fb3 TT	478	* this function is called. Oh well.
	479	*/
	480	unsigned int get_cpu_board_revision(void)
	481	{
	482	struct board_eeprom {
	483	u32 id; /* 0x00 - 0x03 EEPROM Tag 'CCID' */
	484	u8 major; /* 0x04 Board revision, major */
	485	u8 minor; /* 0x05 Board revision, minor */
	486	} be;
	487
6d0f6bcf	488	i2c_read(CONFIG_SYS_I2C_EEPROM_ADDR, 0, CONFIG_SYS_I2C_EEPROM_ADDR_LEN,
e2d31fb3 TT	489	(void *)&be, sizeof(be));
	490
	491	if (be.id != (('C' << 24) \| ('C' << 16) \| ('I' << 8) \| 'D'))
	492	return MPC85XX_CPU_BOARD_REV(0, 0);
	493
	494	if ((be.major == 0xff) && (be.minor == 0xff))
	495	return MPC85XX_CPU_BOARD_REV(0, 0);
	496
e46c7bfb	497	return MPC85XX_CPU_BOARD_REV(be.major, be.minor);
e2d31fb3	498	}
e2d31fb3	499	#endif