board/keymile/common/ivm.c

   1 /*
   2  * (C) Copyright 2011
   3  * Holger Brunck, Keymile GmbH Hannover, holger.brunck@keymile.com
   4  *
   5  * SPDX-License-Identifier:     GPL-2.0+
   6  */
   7
   8 #include <common.h>
   9 #include <cli_hush.h>
  10 #include <i2c.h>
  11 #include "common.h"
  12
  13 #define MAC_STR_SZ      20
  14
  15 static int ivm_calc_crc(unsigned char *buf, int len)
  16 {
  17         const unsigned short crc_tab[16] = {
  18                 0x0000, 0xCC01, 0xD801, 0x1400,
  19                 0xF001, 0x3C00, 0x2800, 0xE401,
  20                 0xA001, 0x6C00, 0x7800, 0xB401,
  21                 0x5000, 0x9C01, 0x8801, 0x4400};
  22
  23         unsigned short crc     = 0;   /* final result */
  24         unsigned short r1      = 0;   /* temp */
  25         unsigned char  byte    = 0;   /* input buffer */
  26         int     i;
  27
  28         /* calculate CRC from array data */
  29         for (i = 0; i < len; i++) {
  30                 byte = buf[i];
  31
  32                 /* lower 4 bits */
  33                 r1 = crc_tab[crc & 0xF];
  34                 crc = ((crc) >> 4) & 0x0FFF;
  35                 crc = crc ^ r1 ^ crc_tab[byte & 0xF];
  36
  37                 /* upper 4 bits */
  38                 r1 = crc_tab[crc & 0xF];
  39                 crc = (crc >> 4) & 0x0FFF;
  40                 crc = crc ^ r1 ^ crc_tab[(byte >> 4) & 0xF];
  41         }
  42         return crc;
  43 }
  44
  45 static int ivm_set_value(char *name, char *value)
  46 {
  47         char tempbuf[256];
  48
  49         if (value != NULL) {
  50                 sprintf(tempbuf, "%s=%s", name, value);
  51                 return set_local_var(tempbuf, 0);
  52         } else {
  53                 unset_local_var(name);
  54         }
  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: \
 184                         %lx EEprom: %lx\n", 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)
 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         if (offset) {
 203                 val += offset;
 204                 mac[3] = (val >> 16) & 0xff;
 205                 mac[4] = (val >> 8) & 0xff;
 206                 mac[5] = val & 0xff;
 207         }
 208
 209         sprintf((char *)valbuf, "%pM", mac);
 210         return 0;
 211 }
 212
 213 static int ivm_analyze_block2(unsigned char *buf, int len)
 214 {
 215         unsigned char   valbuf[MAC_STR_SZ];
 216         unsigned long   count;
 217
 218         /* IVM_MAC Adress begins at offset 1 */
 219         sprintf((char *)valbuf, "%pM", buf + 1);
 220         ivm_set_value("IVM_MacAddress", (char *)valbuf);
 221         /* IVM_MacCount */
 222         count = (buf[10] << 24) +
 223                    (buf[11] << 16) +
 224                    (buf[12] << 8)  +
 225                     buf[13];
 226         if (count == 0xffffffff)
 227                 count = 1;
 228         sprintf((char *)valbuf, "%lx", count);
 229         ivm_set_value("IVM_MacCount", (char *)valbuf);
 230         return 0;
 231 }
 232
 233 int ivm_analyze_eeprom(unsigned char *buf, int len)
 234 {
 235         unsigned short  val;
 236         unsigned char   valbuf[CONFIG_SYS_IVM_EEPROM_PAGE_LEN];
 237         unsigned char   *tmp;
 238
 239         if (ivm_check_crc(buf, 0) != 0)
 240                 return -1;
 241
 242         ivm_get_value(buf, CONFIG_SYS_IVM_EEPROM_PAGE_LEN,
 243                         "IVM_BoardId", 0, 1);
 244         val = ivm_get_value(buf, CONFIG_SYS_IVM_EEPROM_PAGE_LEN,
 245                         "IVM_HWKey", 6, 1);
 246         if (val != 0xffff) {
 247                 sprintf((char *)valbuf, "%x", ((val / 100) % 10));
 248                 ivm_set_value("IVM_HWVariant", (char *)valbuf);
 249                 sprintf((char *)valbuf, "%x", (val % 100));
 250                 ivm_set_value("IVM_HWVersion", (char *)valbuf);
 251         }
 252         ivm_get_value(buf, CONFIG_SYS_IVM_EEPROM_PAGE_LEN,
 253                 "IVM_Functions", 12, 0);
 254
 255         GET_STRING("IVM_Symbol", IVM_POS_SYMBOL_ONLY, 8)
 256         GET_STRING("IVM_DeviceName", IVM_POS_SHORT_TEXT, 64)
 257         tmp = (unsigned char *) getenv("IVM_DeviceName");
 258         if (tmp) {
 259                 int     len = strlen((char *)tmp);
 260                 int     i = 0;
 261
 262                 while (i < len) {
 263                         if (tmp[i] == ';') {
 264                                 ivm_set_value("IVM_ShortText",
 265                                         (char *)&tmp[i + 1]);
 266                                 break;
 267                         }
 268                         i++;
 269                 }
 270                 if (i >= len)
 271                         ivm_set_value("IVM_ShortText", NULL);
 272         } else {
 273                 ivm_set_value("IVM_ShortText", NULL);
 274         }
 275         GET_STRING("IVM_ManufacturerID", IVM_POS_MANU_ID, 32)
 276         GET_STRING("IVM_ManufacturerSerialNumber", IVM_POS_MANU_SERIAL, 20)
 277         GET_STRING("IVM_ManufacturerPartNumber", IVM_POS_PART_NUMBER, 32)
 278         GET_STRING("IVM_ManufacturerBuildState", IVM_POS_BUILD_STATE, 32)
 279         GET_STRING("IVM_SupplierPartNumber", IVM_POS_SUPPLIER_PART_NUMBER, 32)
 280         GET_STRING("IVM_DelieveryDate", IVM_POS_DELIVERY_DATE, 32)
 281         GET_STRING("IVM_SupplierBuildState", IVM_POS_SUPPLIER_BUILD_STATE, 32)
 282         GET_STRING("IVM_CustomerID", IVM_POS_CUSTOMER_ID, 32)
 283         GET_STRING("IVM_CustomerProductID", IVM_POS_CUSTOMER_PROD_ID, 32)
 284
 285         if (ivm_check_crc(&buf[CONFIG_SYS_IVM_EEPROM_PAGE_LEN * 2], 2) != 0)
 286                 return 0;
 287         ivm_analyze_block2(&buf[CONFIG_SYS_IVM_EEPROM_PAGE_LEN * 2],
 288                 CONFIG_SYS_IVM_EEPROM_PAGE_LEN);
 289
 290         return 0;
 291 }
 292
 293 static int ivm_populate_env(unsigned char *buf, int len)
 294 {
 295         unsigned char   *page2;
 296         unsigned char   valbuf[MAC_STR_SZ];
 297
 298         /* do we have the page 2 filled ? if not return */
 299         if (ivm_check_crc(buf, 2))
 300                 return 0;
 301         page2 = &buf[CONFIG_SYS_IVM_EEPROM_PAGE_LEN*2];
 302
 303         /* if an offset is defined, add it */
 304         process_mac(valbuf, page2, CONFIG_PIGGY_MAC_ADRESS_OFFSET);
 305         if (getenv("ethaddr") == NULL)
 306                 setenv((char *)"ethaddr", (char *)valbuf);
 307 #ifdef CONFIG_KMVECT1
 308 /* KMVECT1 has two ethernet interfaces */
 309         if (getenv("eth1addr") == NULL) {
 310                 process_mac(valbuf, page2, 1);
 311                 setenv((char *)"eth1addr", (char *)valbuf);
 312         }
 313 #endif
 314
 315         return 0;
 316 }
 317
 318 int ivm_read_eeprom(unsigned char *buf, int len)
 319 {
 320         int ret;
 321
 322         i2c_set_bus_num(CONFIG_KM_IVM_BUS);
 323         /* add deblocking here */
 324         i2c_make_abort();
 325
 326         ret = i2c_read(CONFIG_SYS_IVM_EEPROM_ADR, 0, 1, buf, len);
 327         if (ret != 0) {
 328                 printf("Error reading EEprom\n");
 329                 return -2;
 330         }
 331
 332         return ivm_populate_env(buf, len);
 333 }