board/keymile/common/ivm.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * (C) Copyright 2011
   4  * Holger Brunck, Keymile GmbH Hannover, holger.brunck@keymile.com
   5  */
   6
   7 #include <cli_hush.h>
   8 #include <env.h>
   9 #include <i2c.h>
  10 #include <stdio.h>
  11 #include <vsprintf.h>
  12 #include "common.h"
  13
  14 #define MAC_STR_SZ      20
  15
  16 static int ivm_calc_crc(unsigned char *buf, int len)
  17 {
  18         const unsigned short crc_tab[16] = {
  19                 0x0000, 0xCC01, 0xD801, 0x1400,
  20                 0xF001, 0x3C00, 0x2800, 0xE401,
  21                 0xA001, 0x6C00, 0x7800, 0xB401,
  22                 0x5000, 0x9C01, 0x8801, 0x4400};
  23
  24         unsigned short crc     = 0;   /* final result */
  25         unsigned short r1      = 0;   /* temp */
  26         unsigned char  byte    = 0;   /* input buffer */
  27         int     i;
  28
  29         /* calculate CRC from array data */
  30         for (i = 0; i < len; i++) {
  31                 byte = buf[i];
  32
  33                 /* lower 4 bits */
  34                 r1 = crc_tab[crc & 0xF];
  35                 crc = ((crc) >> 4) & 0x0FFF;
  36                 crc = crc ^ r1 ^ crc_tab[byte & 0xF];
  37
  38                 /* upper 4 bits */
  39                 r1 = crc_tab[crc & 0xF];
  40                 crc = (crc >> 4) & 0x0FFF;
  41                 crc = crc ^ r1 ^ crc_tab[(byte >> 4) & 0xF];
  42         }
  43         return crc;
  44 }
  45
  46 static int ivm_set_value(char *name, char *value)
  47 {
  48         char tempbuf[256];
  49
  50         if (value) {
  51                 sprintf(tempbuf, "%s=%s", name, value);
  52                 return set_local_var(tempbuf, 0);
  53         }
  54         unset_local_var(name);
  55         return 0;
  56 }
  57
  58 static int ivm_get_value(unsigned char *buf, int len, char *name, int off,
  59                          int check)
  60 {
  61         unsigned short  val;
  62         unsigned char   valbuf[30];
  63
  64         if (buf[off + 0] != buf[off + 2] &&
  65             buf[off + 2] != buf[off + 4]) {
  66                 printf("%s Error corrupted %s\n", __func__, name);
  67                 val = -1;
  68         } else {
  69                 val = buf[off + 0] + (buf[off + 1] << 8);
  70                 if (val == 0 && check == 1)
  71                         val = -1;
  72         }
  73         sprintf((char *)valbuf, "%x", val);
  74         ivm_set_value(name, (char *)valbuf);
  75         return val;
  76 }
  77
  78 #define INV_BLOCKSIZE           0x100
  79 #define INV_DATAADDRESS         0x21
  80 #define INVENTORYDATASIZE       (INV_BLOCKSIZE - INV_DATAADDRESS - 3)
  81
  82 #define IVM_POS_SHORT_TEXT              0
  83 #define IVM_POS_MANU_ID                 1
  84 #define IVM_POS_MANU_SERIAL             2
  85 #define IVM_POS_PART_NUMBER             3
  86 #define IVM_POS_BUILD_STATE             4
  87 #define IVM_POS_SUPPLIER_PART_NUMBER    5
  88 #define IVM_POS_DELIVERY_DATE           6
  89 #define IVM_POS_SUPPLIER_BUILD_STATE    7
  90 #define IVM_POS_CUSTOMER_ID             8
  91 #define IVM_POS_CUSTOMER_PROD_ID        9
  92 #define IVM_POS_HISTORY                 10
  93 #define IVM_POS_SYMBOL_ONLY             11
  94
  95 static char convert_char(char c)
  96 {
  97         return (c < ' ' || c > '~') ? '.' : c;
  98 }
  99
 100 static int ivm_findinventorystring(int type,
 101                                    unsigned char *const string,
 102                                    unsigned long maxlen,
 103                                    unsigned char *buf)
 104 {
 105         int xcode = 0;
 106         unsigned long cr = 0;
 107         unsigned long addr = INV_DATAADDRESS;
 108         unsigned long size = 0;
 109         unsigned long nr = type;
 110         int stop = 0;   /* stop on semicolon */
 111
 112         memset(string, '\0', maxlen);
 113         switch (type) {
 114         case IVM_POS_SYMBOL_ONLY:
 115                 nr = 0;
 116                 stop = 1;
 117         break;
 118         default:
 119                 nr = type;
 120                 stop = 0;
 121         }
 122
 123         /* Look for the requested number of CR. */
 124         while ((cr != nr) && (addr < INVENTORYDATASIZE)) {
 125                 if (buf[addr] == '\r')
 126                         cr++;
 127                 addr++;
 128         }
 129
 130         /*
 131          * the expected number of CR was found until the end of the IVM
 132          *  content --> fill string
 133          */
 134         if (addr < INVENTORYDATASIZE) {
 135                 /* Copy the IVM string in the corresponding string */
 136                 for (; (buf[addr] != '\r')              &&
 137                      ((buf[addr] != ';') ||  (!stop))   &&
 138                      (size < (maxlen - 1)               &&
 139                      (addr < INVENTORYDATASIZE)); addr++) {
 140                         size += sprintf((char *)string + size, "%c",
 141                                         convert_char (buf[addr]));
 142                 }
 143
 144                 /*
 145                  * copy phase is done: check if everything is ok. If not,
 146                  * the inventory data is most probably corrupted: tell
 147                  * the world there is a problem!
 148                  */
 149                 if (addr == INVENTORYDATASIZE) {
 150                         xcode = -1;
 151                         printf("Error end of string not found\n");
 152                 } else if ((size > (maxlen - 1)) &&
 153                            (buf[addr] != '\r')) {
 154                         xcode = -1;
 155                         printf("string too long till next CR\n");
 156                 }
 157         } else {
 158                 /*
 159                  * some CR are missing...
 160                  * the inventory data is most probably corrupted
 161                  */
 162                 xcode = -1;
 163                 printf("not enough cr found\n");
 164         }
 165         return xcode;
 166 }
 167
 168 #define GET_STRING(name, which, len) \
 169         if (ivm_findinventorystring(which, valbuf, len, buf) == 0) { \
 170                 ivm_set_value(name, (char *)valbuf); \
 171         }
 172
 173 static int ivm_check_crc(unsigned char *buf, int block)
 174 {
 175         unsigned long   crc;
 176         unsigned long   crceeprom;
 177
 178         crc = ivm_calc_crc(buf, CONFIG_SYS_IVM_EEPROM_PAGE_LEN - 2);
 179         crceeprom = (buf[CONFIG_SYS_IVM_EEPROM_PAGE_LEN - 1] +
 180                         buf[CONFIG_SYS_IVM_EEPROM_PAGE_LEN - 2] * 256);
 181         if (crc != crceeprom) {
 182                 if (block == 0)
 183                         printf("Error CRC Block: %d EEprom: calculated: %lx EEprom: %lx\n",
 184                                block, crc, crceeprom);
 185                 return -1;
 186         }
 187         return 0;
 188 }
 189
 190 /* take care of the possible MAC address offset and the IVM content offset */
 191 static int process_mac(unsigned char *valbuf, unsigned char *buf,
 192                        int offset, bool unique)
 193 {
 194         unsigned char mac[6];
 195         unsigned long val = (buf[4] << 16) + (buf[5] << 8) + buf[6];
 196
 197         /* use an intermediate buffer, to not change IVM content
 198          * MAC address is at offset 1
 199          */
 200         memcpy(mac, buf + 1, 6);
 201
 202         /* MAC address can be set to locally administred, this is only allowed
 203          * for interfaces which have now connection to the outside. For these
 204          * addresses we need to set the second bit in the first byte.
 205          */
 206         if (!unique)
 207                 mac[0] |= 0x2;
 208
 209         if (offset) {
 210                 val += offset;
 211                 mac[3] = (val >> 16) & 0xff;
 212                 mac[4] = (val >> 8) & 0xff;
 213                 mac[5] = val & 0xff;
 214         }
 215
 216         sprintf((char *)valbuf, "%pM", mac);
 217         return 0;
 218 }
 219
 220 static int ivm_analyze_block2(unsigned char *buf, int len)
 221 {
 222         unsigned char   valbuf[MAC_STR_SZ];
 223         unsigned long   count;
 224
 225         /* IVM_MAC Address begins at offset 1 */
 226         sprintf((char *)valbuf, "%pM", buf + 1);
 227         ivm_set_value("IVM_MacAddress", (char *)valbuf);
 228         /* IVM_MacCount */
 229         count = (buf[10] << 24) +
 230                    (buf[11] << 16) +
 231                    (buf[12] << 8)  +
 232                     buf[13];
 233         if (count == 0xffffffff)
 234                 count = 1;
 235         sprintf((char *)valbuf, "%lx", count);
 236         ivm_set_value("IVM_MacCount", (char *)valbuf);
 237         return 0;
 238 }
 239
 240 int ivm_analyze_eeprom(unsigned char *buf, int len)
 241 {
 242         unsigned short  val;
 243         unsigned char   valbuf[CONFIG_SYS_IVM_EEPROM_PAGE_LEN];
 244         unsigned char   *tmp;
 245
 246         if (ivm_check_crc(buf, 0) != 0)
 247                 return -1;
 248
 249         ivm_get_value(buf, CONFIG_SYS_IVM_EEPROM_PAGE_LEN,
 250                       "IVM_BoardId", 0, 1);
 251         val = ivm_get_value(buf, CONFIG_SYS_IVM_EEPROM_PAGE_LEN,
 252                             "IVM_HWKey", 6, 1);
 253         if (val != 0xffff) {
 254                 sprintf((char *)valbuf, "%x", ((val / 100) % 10));
 255                 ivm_set_value("IVM_HWVariant", (char *)valbuf);
 256                 sprintf((char *)valbuf, "%x", (val % 100));
 257                 ivm_set_value("IVM_HWVersion", (char *)valbuf);
 258         }
 259         ivm_get_value(buf, CONFIG_SYS_IVM_EEPROM_PAGE_LEN,
 260                       "IVM_Functions", 12, 0);
 261
 262         GET_STRING("IVM_Symbol", IVM_POS_SYMBOL_ONLY, 8)
 263         GET_STRING("IVM_DeviceName", IVM_POS_SHORT_TEXT, 64)
 264         tmp = (unsigned char *)env_get("IVM_DeviceName");
 265         if (tmp) {
 266                 int     len = strlen((char *)tmp);
 267                 int     i = 0;
 268
 269                 while (i < len) {
 270                         if (tmp[i] == ';') {
 271                                 ivm_set_value("IVM_ShortText",
 272                                               (char *)&tmp[i + 1]);
 273                                 break;
 274                         }
 275                         i++;
 276                 }
 277                 if (i >= len)
 278                         ivm_set_value("IVM_ShortText", NULL);
 279         } else {
 280                 ivm_set_value("IVM_ShortText", NULL);
 281         }
 282         GET_STRING("IVM_ManufacturerID", IVM_POS_MANU_ID, 32)
 283         GET_STRING("IVM_ManufacturerSerialNumber", IVM_POS_MANU_SERIAL, 20)
 284         GET_STRING("IVM_ManufacturerPartNumber", IVM_POS_PART_NUMBER, 32)
 285         GET_STRING("IVM_ManufacturerBuildState", IVM_POS_BUILD_STATE, 32)
 286         GET_STRING("IVM_SupplierPartNumber", IVM_POS_SUPPLIER_PART_NUMBER, 32)
 287         GET_STRING("IVM_DelieveryDate", IVM_POS_DELIVERY_DATE, 32)
 288         GET_STRING("IVM_SupplierBuildState", IVM_POS_SUPPLIER_BUILD_STATE, 32)
 289         GET_STRING("IVM_CustomerID", IVM_POS_CUSTOMER_ID, 32)
 290         GET_STRING("IVM_CustomerProductID", IVM_POS_CUSTOMER_PROD_ID, 32)
 291
 292         if (ivm_check_crc(&buf[CONFIG_SYS_IVM_EEPROM_PAGE_LEN * 2], 2) != 0)
 293                 return 0;
 294         ivm_analyze_block2(&buf[CONFIG_SYS_IVM_EEPROM_PAGE_LEN * 2],
 295                            CONFIG_SYS_IVM_EEPROM_PAGE_LEN);
 296
 297         return 0;
 298 }
 299
 300 static int ivm_populate_env(unsigned char *buf, int len, int mac_address_offset)
 301 {
 302         unsigned char   *page2;
 303         unsigned char   valbuf[MAC_STR_SZ];
 304
 305         /* do we have the page 2 filled ? if not return */
 306         if (ivm_check_crc(buf, 2))
 307                 return 0;
 308         page2 = &buf[CONFIG_SYS_IVM_EEPROM_PAGE_LEN * 2];
 309
 310         if (IS_ENABLED(CONFIG_TARGET_KMTEGR1)) {
 311                 /* KMTEGR1 has a special setup. eth0 has no connection to the
 312                  * outside and gets an locally administred MAC address, eth1 is
 313                  * the debug interface and gets the official MAC address from
 314                  * the IVM
 315                  */
 316                 process_mac(valbuf, page2, mac_address_offset, false);
 317                 env_set((char *)"ethaddr", (char *)valbuf);
 318                 process_mac(valbuf, page2, mac_address_offset, true);
 319                 env_set((char *)"eth1addr", (char *)valbuf);
 320         } else if (IS_ENABLED(CONFIG_ARCH_LS1021A)) {
 321                 /* LS102xA has 1xRGMII for debug connection and
 322                  * 2xSGMII for back-plane mgmt connection
 323                  */
 324                 process_mac(valbuf, page2, 1, true);
 325                 env_set((char *)"ethaddr", (char *)valbuf);
 326                 process_mac(valbuf, page2, 2, true);
 327                 env_set((char *)"eth1addr", (char *)valbuf);
 328                 process_mac(valbuf, page2, mac_address_offset, true);
 329                 env_set((char *)"eth2addr", (char *)valbuf);
 330         } else {
 331                 process_mac(valbuf, page2, mac_address_offset, true);
 332                 env_set((char *)"ethaddr", (char *)valbuf);
 333         }
 334         if (IS_ENABLED(CONFIG_TARGET_KMCENT2)) {
 335                 /* 3rd ethernet interface */
 336                 process_mac(valbuf, page2, 2, true);
 337                 env_set((char *)"eth4addr", (char *)valbuf);
 338         }
 339
 340         return 0;
 341 }
 342
 343 int ivm_read_eeprom(unsigned char *buf, int len, int mac_address_offset)
 344 {
 345         struct udevice *eedev = NULL;
 346         int ret;
 347
 348         ret = i2c_get_chip_for_busnum(CONFIG_KM_IVM_BUS,
 349                                       CONFIG_SYS_IVM_EEPROM_ADR, 1, &eedev);
 350         if (ret) {
 351                 printf("failed to get device for EEPROM at address 0x%02x\n",
 352                        CONFIG_SYS_IVM_EEPROM_ADR);
 353                 return 1;
 354         }
 355
 356 #if CONFIG_IS_ENABLED(ARCH_LS1021A)
 357         /* add deblocking here */
 358         i2c_make_abort();
 359 #endif
 360
 361         ret = dm_i2c_read(eedev, 0, buf, len);
 362         if (ret != 0) {
 363                 printf("Error: Unable to read from I2C EEPROM at address %02X:%02X\n",
 364                        CONFIG_SYS_IVM_EEPROM_ADR, 0);
 365                 return 1;
 366         }
 367
 368         return ivm_populate_env(buf, len, mac_address_offset);
 369 }