3 * Erik Theisen, Wave 7 Optics, etheisen@mindspring.com.
5 * See file CREDITS for list of people who contributed to this
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License as
10 * published by the Free Software Foundation; either version 2 of
11 * the License, or (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
27 # define CONFIG_SYS_DEF_EEPROM_ADDR 0xa0
28 extern char iicReadByte( char, char );
29 extern ulong_t crc32( unsigned char *, unsigned long );
37 * vpd_reader() - reads VPD data from I2C EEPROMS.
38 * returns pointer to buffer or NULL.
40 static unsigned char *
41 vpd_reader(unsigned char *buf, unsigned dev_addr, unsigned off, unsigned count)
43 unsigned offset = off; /* Calculated offset */
46 * The main board EEPROM contains
47 * SDRAM SPD in the first 128 bytes,
50 if (dev_addr == CONFIG_SYS_DEF_EEPROM_ADDR)
51 offset += SDRAM_SPD_DATA_SIZE;
53 /* Try to read the I2C EEPROM */
57 for( i = 0; i < count; ++i ) {
58 buf[ i ] = iicReadByte( dev_addr, offset+i );
62 if (eeprom_read(dev_addr, offset, buf, count)) {
63 printf("Failed to read %d bytes from VPD EEPROM 0x%x @ 0x%x\n",
64 count, dev_addr, offset);
74 * vpd_get_packet() - returns next VPD packet or NULL.
76 static vpd_packet_t *vpd_get_packet(vpd_packet_t *vpd_packet)
78 vpd_packet_t *packet = vpd_packet;
81 if (packet->identifier == VPD_PID_TERM)
84 packet = (vpd_packet_t *)((char *)packet + packet->size + 2);
88 } /* vpd_get_packet() */
92 * vpd_find_packet() - Locates and returns the specified
93 * VPD packet or NULL on error.
95 static vpd_packet_t *vpd_find_packet(vpd_t *vpd, unsigned char ident)
97 vpd_packet_t *packet = (vpd_packet_t *)&vpd->packets;
99 /* Guaranteed illegal */
100 if (ident == VPD_PID_GI)
103 /* Scan tuples looking for a match */
104 while ((packet->identifier != ident) &&
105 (packet->identifier != VPD_PID_TERM))
106 packet = vpd_get_packet(packet);
108 /* Did we find it? */
109 if ((packet->identifier) && (packet->identifier != ident))
116 * vpd_is_valid() - Validates contents of VPD data
117 * in I2C EEPROM. Returns 1 for
118 * success or 0 for failure.
120 static int vpd_is_valid(unsigned dev_addr, unsigned char *buf)
123 vpd_packet_t *packet;
124 vpd_t *vpd = (vpd_t *)buf;
125 unsigned short stored_crc16, calc_crc16 = 0xffff;
127 /* Check Eyecatcher */
128 if (strncmp((char *)(vpd->header.eyecatcher), VPD_EYECATCHER, VPD_EYE_SIZE) != 0) {
130 if (dev_addr == CONFIG_SYS_DEF_EEPROM_ADDR)
131 offset += SDRAM_SPD_DATA_SIZE;
132 printf("Error: VPD EEPROM 0x%x corrupt @ 0x%x\n", dev_addr, offset);
138 if (vpd->header.size> VPD_MAX_EEPROM_SIZE) {
139 printf("Error: VPD EEPROM 0x%x contains bad size 0x%x\n",
140 dev_addr, vpd->header.size);
144 /* Now find the termination packet */
145 if ((packet = vpd_find_packet(vpd, VPD_PID_TERM)) == NULL) {
146 printf("Error: VPD EEPROM 0x%x missing termination packet\n",
151 /* Calculate data size */
152 num_bytes = (unsigned long)((unsigned char *)packet -
153 (unsigned char *)vpd + sizeof(vpd_packet_t));
155 /* Find stored CRC and clear it */
156 if ((packet = vpd_find_packet(vpd, VPD_PID_CRC)) == NULL) {
157 printf("Error: VPD EEPROM 0x%x missing CRC\n", dev_addr);
160 stored_crc16 = *((ushort *)packet->data);
161 *(ushort *)packet->data = 0;
163 /* OK, lets calculate the CRC and check it */
165 calc_crc16 = (0xffff & crc32(buf, num_bytes));
167 calc_crc16 = (0xffff & crc32(0, buf, num_bytes));
169 *(ushort *)packet->data = stored_crc16; /* Now restore the CRC */
170 if (stored_crc16 != calc_crc16) {
171 printf("Error: VPD EEPROM 0x%x has bad CRC 0x%x\n",
172 dev_addr, stored_crc16);
177 } /* vpd_is_valid() */
181 * size_ok() - Check to see if packet size matches
182 * size of data we want. Returns 1 for
183 * good match or 0 for failure.
185 static int size_ok(vpd_packet_t *packet, unsigned long size)
187 if (packet->size != size) {
188 printf("VPD Packet 0x%x corrupt.\n", packet->identifier);
196 * strlen_ok() - Check to see if packet size matches
197 * strlen of the string we want to populate.
198 * Returns 1 for valid length or 0 for failure.
200 static int strlen_ok(vpd_packet_t *packet, unsigned long length)
202 if (packet->size >= length) {
203 printf("VPD Packet 0x%x corrupt.\n", packet->identifier);
211 * get_vpd_data() - populates the passed VPD structure 'vpdInfo'
212 * with data obtained from the specified
213 * I2C EEPROM 'dev_addr'. Returns 0 for
214 * success or 1 for failure.
216 int vpd_get_data(unsigned char dev_addr, VPD *vpdInfo)
218 unsigned char buf[VPD_EEPROM_SIZE];
219 vpd_t *vpd = (vpd_t *)buf;
220 vpd_packet_t *packet;
226 * Fill vpdInfo with 0s to blank out
227 * unused fields, fill vpdInfo->ethAddrs
228 * with all 0xffs so that other's code can
229 * determine how many real Ethernet addresses
230 * there are. OUIs starting with 0xff are
231 * broadcast addresses, and would never be
234 memset((void *)vpdInfo, 0, sizeof(VPD));
235 memset((void *)&vpdInfo->ethAddrs, 0xff, sizeof(vpdInfo->ethAddrs));
236 vpdInfo->_devAddr = dev_addr;
238 /* Read the minimum size first */
239 if (vpd_reader(buf, dev_addr, 0, VPD_EEPROM_SIZE) == NULL) {
243 /* Check validity of VPD data */
244 if (!vpd_is_valid(dev_addr, buf)) {
245 printf("VPD Data is INVALID!\n");
250 * Walk all the packets and populate
251 * the VPD info structure.
253 packet = (vpd_packet_t *)&vpd->packets;
255 switch (packet->identifier) {
257 printf("Error: Illegal VPD value\n");
260 if (strlen_ok(packet, MAX_PROD_ID)) {
261 strncpy(vpdInfo->productId,
262 (char *)(packet->data), packet->size);
266 if (size_ok(packet, sizeof(char)))
267 vpdInfo->revisionId = *packet->data;
270 if (size_ok(packet, sizeof(unsigned long))) {
272 *(unsigned long *)packet->data;
276 if (size_ok(packet, sizeof(unsigned char)))
277 vpdInfo->manuID = *packet->data;
280 if (size_ok(packet, sizeof(unsigned long))) {
282 *(unsigned long *)packet->data;
286 if (size_ok(packet, sizeof(unsigned long)))
287 vpdInfo->sysClk = *(unsigned long *)packet->data;
290 if (size_ok(packet, sizeof(unsigned long)))
291 vpdInfo->serClk = *(unsigned long *)packet->data;
294 if (size_ok(packet, 9)) { /* XXX - hardcoded,
296 memcpy(&vpdInfo->flashCfg, packet->data, 9);
299 case VPD_PID_ETHADDR:
300 memcpy(vpdInfo->ethAddrs, packet->data, packet->size);
303 if (size_ok(packet, sizeof(char)))
304 vpdInfo->numPOTS = (unsigned)*packet->data;
307 if (size_ok(packet, sizeof(char)))
308 vpdInfo->numDS1 = (unsigned)*packet->data;
314 printf("Warning: Found unknown VPD packet ID 0x%x\n",
318 } while ((packet = vpd_get_packet(packet)));
321 } /* end get_vpd_data() */
325 * vpd_init() - Initialize default VPD environment
327 int vpd_init(unsigned char dev_addr)
334 * vpd_print() - Pretty print the VPD data.
336 void vpd_print(VPD *vpdInfo)
338 const char *const sp = "";
339 const char *const sfmt = "%4s%-20s: \"%s\"\n";
340 const char *const cfmt = "%4s%-20s: '%c'\n";
341 const char *const dfmt = "%4s%-20s: %ld\n";
342 const char *const hfmt = "%4s%-20s: %08lX\n";
343 const char *const dsfmt = "%4s%-20s: %d\n";
344 const char *const hsfmt = "%4s%-20s: %04X\n";
345 const char *const dhfmt = "%4s%-20s: %ld (%lX)\n";
347 printf("VPD read from I2C device: %02X\n", vpdInfo->_devAddr);
349 if (vpdInfo->productId[0])
350 printf(sfmt, sp, "Product ID", vpdInfo->productId);
352 printf(sfmt, sp, "Product ID", "UNKNOWN");
354 if (vpdInfo->revisionId)
355 printf(cfmt, sp, "Revision ID", vpdInfo->revisionId);
357 if (vpdInfo->serialNum)
358 printf(dfmt, sp, "Serial Number", vpdInfo->serialNum);
361 printf(dfmt, sp, "Manufacture ID", (long)vpdInfo->manuID);
363 if (vpdInfo->configOpt)
364 printf(hfmt, sp, "Configuration", vpdInfo->configOpt);
367 printf(dhfmt, sp, "System Clock", vpdInfo->sysClk, vpdInfo->sysClk);
370 printf(dhfmt, sp, "Serial Clock", vpdInfo->serClk, vpdInfo->serClk);
372 if (vpdInfo->numPOTS)
373 printf(dfmt, sp, "Number of POTS lines", vpdInfo->numPOTS);
376 printf(dfmt, sp, "Number of DS1s", vpdInfo->numDS1);
378 /* Print Ethernet Addresses */
379 if (vpdInfo->ethAddrs[0][0] != 0xff) {
381 printf("%4sEtherNet Address(es): ", sp);
382 for (i = 0; i < MAX_ETH_ADDRS; i++) {
383 if (vpdInfo->ethAddrs[i][0] != 0xff) {
384 for (j = 0; j < 6; j++) {
385 printf("%02X", vpdInfo->ethAddrs[i][j]);
386 if (((j + 1) % 6) != 0)
391 if (((i + 1) % 3) == 0) printf("\n%24s: ", sp);
397 if (vpdInfo->flashCfg.mfg && vpdInfo->flashCfg.dev) {
398 printf("Main Flash Configuration:\n");
399 printf(hsfmt, sp, "Manufacture ID", vpdInfo->flashCfg.mfg);
400 printf(hsfmt, sp, "Device ID", vpdInfo->flashCfg.dev);
401 printf(dsfmt, sp, "Device Width", vpdInfo->flashCfg.devWidth);
402 printf(dsfmt, sp, "Num. Devices", vpdInfo->flashCfg.numDevs);
403 printf(dsfmt, sp, "Num. Columns", vpdInfo->flashCfg.numCols);
404 printf(dsfmt, sp, "Column Width", vpdInfo->flashCfg.colWidth);
405 printf(dsfmt, sp, "WE Data Width", vpdInfo->flashCfg.weDataWidth);