common: Drop linux/delay.h from common header
[oweals/u-boot.git] / board / freescale / common / sys_eeprom.c
1 // SPDX-License-Identifier: GPL-2.0+
2 /*
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)
7  */
8
9 #include <common.h>
10 #include <command.h>
11 #include <env.h>
12 #include <i2c.h>
13 #include <init.h>
14 #include <linux/ctype.h>
15 #include <linux/delay.h>
16 #include <u-boot/crc.h>
17
18 #ifdef CONFIG_SYS_I2C_EEPROM_CCID
19 #include "../common/eeprom.h"
20 #define MAX_NUM_PORTS   8
21 #endif
22
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 */
26 #ifndef MAX_NUM_PORTS
27 #define MAX_NUM_PORTS   16
28 #endif
29 #define NXID_VERSION    1
30 #endif
31
32 /**
33  * static eeprom: EEPROM layout for CCID or NXID formats
34  *
35  * See application note AN3638 for details.
36  */
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 */
50 #endif
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 */
67 #endif
68 } e;
69
70 /* Set to 1 if we've read EEPROM into memory */
71 static int has_been_read = 0;
72
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'))
77 #endif
78
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'))
83 #endif
84
85 /**
86  * show_eeprom - display the contents of the EEPROM
87  */
88 static void show_eeprom(void)
89 {
90         int i;
91         unsigned int crc;
92
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));
97 #else
98         printf("ID: %c%c%c%c\n", e.id[0], e.id[1], e.id[2], e.id[3]);
99 #endif
100
101         /* Serial number */
102         printf("SN: %s\n", e.sn);
103
104         /* Errata level. */
105 #ifdef CONFIG_SYS_I2C_EEPROM_NXID
106         printf("Errata: %s\n", e.errata);
107 #else
108         printf("Errata: %c%c\n",
109                 e.errata[0] ? e.errata[0] : '.',
110                 e.errata[1] ? e.errata[1] : '.');
111 #endif
112
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" : "");
118
119         /* Show MAC addresses  */
120         for (i = 0; i < min(e.mac_count, (u8)MAX_NUM_PORTS); i++) {
121
122                 u8 *p = e.mac[i];
123
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]);
126         }
127
128         crc = crc32(0, (void *)&e, sizeof(e) - 4);
129
130         if (crc == be32_to_cpu(e.crc))
131                 printf("CRC: %08x\n", be32_to_cpu(e.crc));
132         else
133                 printf("CRC: %08x (should be %08x)\n",
134                         be32_to_cpu(e.crc), crc);
135
136 #ifdef DEBUG
137         printf("EEPROM dump: (0x%x bytes)\n", sizeof(e));
138         for (i = 0; i < sizeof(e); i++) {
139                 if ((i % 16) == 0)
140                         printf("%02X: ", i);
141                 printf("%02X ", ((u8 *)&e)[i]);
142                 if (((i % 16) == 15) || (i == sizeof(e) - 1))
143                         printf("\n");
144         }
145 #endif
146 }
147
148 /**
149  * read_eeprom - read the EEPROM into memory
150  */
151 static int read_eeprom(void)
152 {
153         int ret;
154 #ifdef CONFIG_SYS_EEPROM_BUS_NUM
155 #ifndef CONFIG_DM_I2C
156         unsigned int bus;
157 #endif
158 #endif
159
160         if (has_been_read)
161                 return 0;
162
163 #ifdef CONFIG_SYS_EEPROM_BUS_NUM
164 #ifndef CONFIG_DM_I2C
165         bus = i2c_get_bus_num();
166         i2c_set_bus_num(CONFIG_SYS_EEPROM_BUS_NUM);
167 #endif
168 #endif
169
170 #ifndef CONFIG_DM_I2C
171         ret = i2c_read(CONFIG_SYS_I2C_EEPROM_ADDR, 0,
172                        CONFIG_SYS_I2C_EEPROM_ADDR_LEN,
173                        (void *)&e, sizeof(e));
174 #else
175         struct udevice *dev;
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, 1, &dev);
179 #else
180         ret = i2c_get_chip_for_busnum(0, CONFIG_SYS_I2C_EEPROM_ADDR, 1, &dev);
181 #endif
182         if (!ret)
183                 ret = dm_i2c_read(dev, 0, (void *)&e, sizeof(e));
184 #endif
185
186 #ifdef CONFIG_SYS_EEPROM_BUS_NUM
187 #ifndef CONFIG_DM_I2C
188         i2c_set_bus_num(bus);
189 #endif
190 #endif
191
192 #ifdef DEBUG
193         show_eeprom();
194 #endif
195
196         has_been_read = (ret == 0) ? 1 : 0;
197
198         return ret;
199 }
200
201 /**
202  *  update_crc - update the CRC
203  *
204  *  This function should be called after each update to the EEPROM structure,
205  *  to make sure the CRC is always correct.
206  */
207 static void update_crc(void)
208 {
209         u32 crc;
210
211         crc = crc32(0, (void *)&e, sizeof(e) - 4);
212         e.crc = cpu_to_be32(crc);
213 }
214
215 /**
216  * prog_eeprom - write the EEPROM from memory
217  */
218 static int prog_eeprom(void)
219 {
220         int ret = 0;
221         int i;
222         void *p;
223 #ifdef CONFIG_SYS_EEPROM_BUS_NUM
224 #ifndef CONFIG_DM_I2C
225         unsigned int bus;
226 #endif
227 #endif
228
229         /* Set the reserved values to 0xFF   */
230 #ifdef CONFIG_SYS_I2C_EEPROM_NXID
231         e.res_0 = 0xFF;
232         memset(e.res_1, 0xFF, sizeof(e.res_1));
233 #else
234         memset(e.res_0, 0xFF, sizeof(e.res_0));
235 #endif
236         update_crc();
237
238 #ifndef CONFIG_DM_I2C
239 #ifdef CONFIG_SYS_EEPROM_BUS_NUM
240         bus = i2c_get_bus_num();
241         i2c_set_bus_num(CONFIG_SYS_EEPROM_BUS_NUM);
242 #endif
243 #endif
244
245         /*
246          * The AT24C02 datasheet says that data can only be written in page
247          * mode, which means 8 bytes at a time, and it takes up to 5ms to
248          * complete a given write.
249          */
250         for (i = 0, p = &e; i < sizeof(e); i += 8, p += 8) {
251 #ifndef CONFIG_DM_I2C
252                 ret = i2c_write(CONFIG_SYS_I2C_EEPROM_ADDR, i,
253                                 CONFIG_SYS_I2C_EEPROM_ADDR_LEN,
254                                 p, min((int)(sizeof(e) - i), 8));
255 #else
256                 struct udevice *dev;
257 #ifdef CONFIG_SYS_EEPROM_BUS_NUM
258                 ret = i2c_get_chip_for_busnum(CONFIG_SYS_EEPROM_BUS_NUM,
259                                               CONFIG_SYS_I2C_EEPROM_ADDR,
260                                               CONFIG_SYS_I2C_EEPROM_ADDR_LEN,
261                                               &dev);
262 #else
263                 ret = i2c_get_chip_for_busnum(0, CONFIG_SYS_I2C_EEPROM_ADDR,
264                                               CONFIG_SYS_I2C_EEPROM_ADDR_LEN,
265                                               &dev);
266 #endif
267                 if (!ret)
268                         ret = dm_i2c_write(dev, i, p, min((int)(sizeof(e) - i),
269                                                           8));
270 #endif
271                 if (ret)
272                         break;
273                 udelay(5000);   /* 5ms write cycle timing */
274         }
275
276         if (!ret) {
277                 /* Verify the write by reading back the EEPROM and comparing */
278                 struct eeprom e2;
279
280 #ifndef CONFIG_DM_I2C
281                 ret = i2c_read(CONFIG_SYS_I2C_EEPROM_ADDR, 0,
282                                CONFIG_SYS_I2C_EEPROM_ADDR_LEN,
283                                (void *)&e2, sizeof(e2));
284 #else
285                 struct udevice *dev;
286 #ifdef CONFIG_SYS_EEPROM_BUS_NUM
287                 ret = i2c_get_chip_for_busnum(CONFIG_SYS_EEPROM_BUS_NUM,
288                                               CONFIG_SYS_I2C_EEPROM_ADDR,
289                                               CONFIG_SYS_I2C_EEPROM_ADDR_LEN,
290                                               &dev);
291 #else
292                 ret = i2c_get_chip_for_busnum(0, CONFIG_SYS_I2C_EEPROM_ADDR,
293                                               CONFIG_SYS_I2C_EEPROM_ADDR_LEN,
294                                               &dev);
295 #endif
296                 if (!ret)
297                         ret = dm_i2c_read(dev, 0, (void *)&e2, sizeof(e2));
298 #endif
299                 if (!ret && memcmp(&e, &e2, sizeof(e)))
300                         ret = -1;
301         }
302
303 #ifndef CONFIG_DM_I2C
304 #ifdef CONFIG_SYS_EEPROM_BUS_NUM
305         i2c_set_bus_num(bus);
306 #endif
307 #endif
308
309         if (ret) {
310                 printf("Programming failed.\n");
311                 has_been_read = 0;
312                 return -1;
313         }
314
315         printf("Programming passed.\n");
316         return 0;
317 }
318
319 /**
320  * h2i - converts hex character into a number
321  *
322  * This function takes a hexadecimal character (e.g. '7' or 'C') and returns
323  * the integer equivalent.
324  */
325 static inline u8 h2i(char p)
326 {
327         if ((p >= '0') && (p <= '9'))
328                 return p - '0';
329
330         if ((p >= 'A') && (p <= 'F'))
331                 return (p - 'A') + 10;
332
333         if ((p >= 'a') && (p <= 'f'))
334                 return (p - 'a') + 10;
335
336         return 0;
337 }
338
339 /**
340  * set_date - stores the build date into the EEPROM
341  *
342  * This function takes a pointer to a string in the format "YYMMDDhhmmss"
343  * (2-digit year, 2-digit month, etc), converts it to a 6-byte BCD string,
344  * and stores it in the build date field of the EEPROM local copy.
345  */
346 static void set_date(const char *string)
347 {
348         unsigned int i;
349
350         if (strlen(string) != 12) {
351                 printf("Usage: mac date YYMMDDhhmmss\n");
352                 return;
353         }
354
355         for (i = 0; i < 6; i++)
356                 e.date[i] = h2i(string[2 * i]) << 4 | h2i(string[2 * i + 1]);
357
358         update_crc();
359 }
360
361 /**
362  * set_mac_address - stores a MAC address into the EEPROM
363  *
364  * This function takes a pointer to MAC address string
365  * (i.e."XX:XX:XX:XX:XX:XX", where "XX" is a two-digit hex number) and
366  * stores it in one of the MAC address fields of the EEPROM local copy.
367  */
368 static void set_mac_address(unsigned int index, const char *string)
369 {
370         char *p = (char *) string;
371         unsigned int i;
372
373         if ((index >= MAX_NUM_PORTS) || !string) {
374                 printf("Usage: mac <n> XX:XX:XX:XX:XX:XX\n");
375                 return;
376         }
377
378         for (i = 0; *p && (i < 6); i++) {
379                 e.mac[index][i] = simple_strtoul(p, &p, 16);
380                 if (*p == ':')
381                         p++;
382         }
383
384         update_crc();
385 }
386
387 int do_mac(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])
388 {
389         char cmd;
390
391         if (argc == 1) {
392                 show_eeprom();
393                 return 0;
394         }
395
396         cmd = argv[1][0];
397
398         if (cmd == 'r') {
399                 read_eeprom();
400                 return 0;
401         }
402
403         if (cmd == 'i') {
404 #ifdef CONFIG_SYS_I2C_EEPROM_NXID
405                 memcpy(e.id, "NXID", sizeof(e.id));
406                 e.version = cpu_to_be32(NXID_VERSION);
407 #else
408                 memcpy(e.id, "CCID", sizeof(e.id));
409 #endif
410                 update_crc();
411                 return 0;
412         }
413
414         if (!is_valid) {
415                 printf("Please read the EEPROM ('r') and/or set the ID ('i') first.\n");
416                 return 0;
417         }
418
419         if (argc == 2) {
420                 switch (cmd) {
421                 case 's':       /* save */
422                         prog_eeprom();
423                         break;
424                 default:
425                         return cmd_usage(cmdtp);
426                 }
427
428                 return 0;
429         }
430
431         /* We know we have at least one parameter  */
432
433         switch (cmd) {
434         case 'n':       /* serial number */
435                 memset(e.sn, 0, sizeof(e.sn));
436                 strncpy((char *)e.sn, argv[2], sizeof(e.sn) - 1);
437                 update_crc();
438                 break;
439         case 'e':       /* errata */
440 #ifdef CONFIG_SYS_I2C_EEPROM_NXID
441                 memset(e.errata, 0, 5);
442                 strncpy((char *)e.errata, argv[2], 4);
443 #else
444                 e.errata[0] = argv[2][0];
445                 e.errata[1] = argv[2][1];
446 #endif
447                 update_crc();
448                 break;
449         case 'd':       /* date BCD format YYMMDDhhmmss */
450                 set_date(argv[2]);
451                 break;
452         case 'p':       /* MAC table size */
453                 e.mac_count = simple_strtoul(argv[2], NULL, 16);
454                 update_crc();
455                 break;
456         case '0' ... '9':       /* "mac 0" through "mac 22" */
457                 set_mac_address(simple_strtoul(argv[1], NULL, 10), argv[2]);
458                 break;
459         case 'h':       /* help */
460         default:
461                 return cmd_usage(cmdtp);
462         }
463
464         return 0;
465 }
466
467 /**
468  * mac_read_from_eeprom - read the MAC addresses from EEPROM
469  *
470  * This function reads the MAC addresses from EEPROM and sets the
471  * appropriate environment variables for each one read.
472  *
473  * The environment variables are only set if they haven't been set already.
474  * This ensures that any user-saved variables are never overwritten.
475  *
476  * This function must be called after relocation.
477  *
478  * For NXID v1 EEPROMs, we support loading and up-converting the older NXID v0
479  * format.  In a v0 EEPROM, there are only eight MAC addresses and the CRC is
480  * located at a different offset.
481  */
482 int mac_read_from_eeprom(void)
483 {
484         unsigned int i;
485         u32 crc, crc_offset = offsetof(struct eeprom, crc);
486         u32 *crcp; /* Pointer to the CRC in the data read from the EEPROM */
487
488         puts("EEPROM: ");
489
490         if (read_eeprom()) {
491                 printf("Read failed.\n");
492                 return 0;
493         }
494
495         if (!is_valid) {
496                 printf("Invalid ID (%02x %02x %02x %02x)\n",
497                        e.id[0], e.id[1], e.id[2], e.id[3]);
498                 return 0;
499         }
500
501 #ifdef CONFIG_SYS_I2C_EEPROM_NXID
502         /*
503          * If we've read an NXID v0 EEPROM, then we need to set the CRC offset
504          * to where it is in v0.
505          */
506         if (e.version == 0)
507                 crc_offset = 0x72;
508 #endif
509
510         crc = crc32(0, (void *)&e, crc_offset);
511         crcp = (void *)&e + crc_offset;
512         if (crc != be32_to_cpu(*crcp)) {
513                 printf("CRC mismatch (%08x != %08x)\n", crc, be32_to_cpu(e.crc));
514                 return 0;
515         }
516
517 #ifdef CONFIG_SYS_I2C_EEPROM_NXID
518         /*
519          * MAC address #9 in v1 occupies the same position as the CRC in v0.
520          * Erase it so that it's not mistaken for a MAC address.  We'll
521          * update the CRC later.
522          */
523         if (e.version == 0)
524                 memset(e.mac[8], 0xff, 6);
525 #endif
526
527         for (i = 0; i < min(e.mac_count, (u8)MAX_NUM_PORTS); i++) {
528                 if (memcmp(&e.mac[i], "\0\0\0\0\0\0", 6) &&
529                     memcmp(&e.mac[i], "\xFF\xFF\xFF\xFF\xFF\xFF", 6)) {
530                         char ethaddr[18];
531                         char enetvar[9];
532
533                         sprintf(ethaddr, "%02X:%02X:%02X:%02X:%02X:%02X",
534                                 e.mac[i][0],
535                                 e.mac[i][1],
536                                 e.mac[i][2],
537                                 e.mac[i][3],
538                                 e.mac[i][4],
539                                 e.mac[i][5]);
540                         sprintf(enetvar, i ? "eth%daddr" : "ethaddr", i);
541                         /* Only initialize environment variables that are blank
542                          * (i.e. have not yet been set)
543                          */
544                         if (!env_get(enetvar))
545                                 env_set(enetvar, ethaddr);
546                 }
547         }
548
549 #ifdef CONFIG_SYS_I2C_EEPROM_NXID
550         printf("%c%c%c%c v%u\n", e.id[0], e.id[1], e.id[2], e.id[3],
551                be32_to_cpu(e.version));
552 #else
553         printf("%c%c%c%c\n", e.id[0], e.id[1], e.id[2], e.id[3]);
554 #endif
555
556 #ifdef CONFIG_SYS_I2C_EEPROM_NXID
557         /*
558          * Now we need to upconvert the data into v1 format.  We do this last so
559          * that at boot time, U-Boot will still say "NXID v0".
560          */
561         if (e.version == 0) {
562                 e.version = cpu_to_be32(NXID_VERSION);
563                 update_crc();
564         }
565 #endif
566
567         return 0;
568 }
569
570 #ifdef CONFIG_SYS_I2C_EEPROM_CCID
571
572 /**
573  * get_cpu_board_revision - get the CPU board revision on 85xx boards
574  *
575  * Read the EEPROM to determine the board revision.
576  *
577  * This function is called before relocation, so we need to read a private
578  * copy of the EEPROM into a local variable on the stack.
579  *
580  * Also, we assume that CONFIG_SYS_EEPROM_BUS_NUM == CONFIG_SYS_SPD_BUS_NUM.  The global
581  * variable i2c_bus_num must be compile-time initialized to CONFIG_SYS_SPD_BUS_NUM,
582  * so that the SPD code will work.  This means that all pre-relocation I2C
583  * operations can only occur on the CONFIG_SYS_SPD_BUS_NUM bus.  So if
584  * CONFIG_SYS_EEPROM_BUS_NUM != CONFIG_SYS_SPD_BUS_NUM, then we can't read the EEPROM when
585  * this function is called.  Oh well.
586  */
587 unsigned int get_cpu_board_revision(void)
588 {
589         struct board_eeprom {
590                 u32 id;           /* 0x00 - 0x03 EEPROM Tag 'CCID' */
591                 u8 major;         /* 0x04        Board revision, major */
592                 u8 minor;         /* 0x05        Board revision, minor */
593         } be;
594
595 #ifndef CONFIG_DM_I2C
596         i2c_read(CONFIG_SYS_I2C_EEPROM_ADDR, 0, CONFIG_SYS_I2C_EEPROM_ADDR_LEN,
597                 (void *)&be, sizeof(be));
598 #else
599         struct udevice *dev;
600         int ret;
601 #ifdef CONFIG_SYS_EEPROM_BUS_NUM
602         ret = i2c_get_chip_for_busnum(CONFIG_SYS_EEPROM_BUS_NUM,
603                                       CONFIG_SYS_I2C_EEPROM_ADDR,
604                                       CONFIG_SYS_I2C_EEPROM_ADDR_LEN,
605                                       &dev);
606 #else
607         ret = i2c_get_chip_for_busnum(0, CONFIG_SYS_I2C_EEPROM_ADDR,
608                                       CONFIG_SYS_I2C_EEPROM_ADDR_LEN,
609                                       &dev);
610 #endif
611         if (!ret)
612                 dm_i2c_read(dev, 0, (void *)&be, sizeof(be));
613 #endif
614
615         if (be.id != (('C' << 24) | ('C' << 16) | ('I' << 8) | 'D'))
616                 return MPC85XX_CPU_BOARD_REV(0, 0);
617
618         if ((be.major == 0xff) && (be.minor == 0xff))
619                 return MPC85XX_CPU_BOARD_REV(0, 0);
620
621         return MPC85XX_CPU_BOARD_REV(be.major, be.minor);
622 }
623 #endif