1 files changed, 682 insertions, 0 deletions

diff --git a/common/recipes-lib/fruid/files/fruid.c b/common/recipes-lib/fruid/files/fruid.c
new file mode 100644
index 0000000..dc71ac8
--- /dev/null
+++ b/common/recipes-lib/fruid/files/fruid.c
@@ -0,0 +1,682 @@
+/*
+ * Copyright 2015-present Facebook. All Rights Reserved.
+ *
+ * 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., 675 Mass Ave, Cambridge, MA 02139, USA.
+ */
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <errno.h>
+#include <string.h>
+#include <syslog.h>
+#include <time.h>
+#include "fruid.h"
+
+#define FIELD_TYPE(x)     ((x & (0x03 << 6)) >> 6)
+#define FIELD_LEN(x)      (x & ~(0x03 << 6))
+#define FIELD_EMPTY       "N/A"
+
+/* Unix time difference between 1970 and 1996. */
+#define UNIX_TIMESTAMP_1996   820454400
+
+/* Array for BCD Plus definition. */
+const char bcd_plus_array[] = "0123456789 -.XXX";
+
+/* Array for 6-Bit ASCII definition. */
+const char * ascii_6bit[4] = {
+  " !\"#$%&'()*+,-./",
+  "0123456789:;<=>?",
+  "@ABCDEFGHIJKLMNO",
+  "PQRSTUVWXYZ[\\]^_"
+};
+
+/*
+ * calculate_time - calculate time from the unix time stamp stored
+ *
+ * @mfg_time    : Unix timestamp since 1996
+ *
+ * returns char * for mfg_time_str
+ * returns NULL for memory allocation failure
+ */
+static char * calculate_time(uint8_t * mfg_time)
+{
+  int len;
+  struct tm * local;
+  time_t unix_time = 0;
+  unix_time = ((mfg_time[2] << 16) + (mfg_time[1] << 8) + mfg_time[0]) * 60;
+  unix_time += UNIX_TIMESTAMP_1996;
+
+  local = localtime(&unix_time);
+  char * str = asctime(local);
+
+  len = strlen(str);
+
+  char * mfg_time_str = (char *) malloc(len);
+  if (!mfg_time_str) {
+    syslog(LOG_ALERT, "fruid: malloc: memory allocation failed\n");
+    return NULL;
+  }
+
+  memset(mfg_time_str, 0, len);
+
+  memcpy(mfg_time_str, str, len);
+
+  mfg_time_str[len - 1] = '\0';
+
+  return mfg_time_str;
+}
+
+/*
+ * verify_chksum - verify the zero checksum of the data
+ *
+ * @area        : offset of the area
+ * @len         : len of the area in bytes
+ * @chksum_read : stored checksum in the data.
+ *
+ * returns 0 if chksum is verified
+ * returns -1 if there exist a mismatch
+ */
+static int verify_chksum(uint8_t * area, uint8_t len, uint8_t chksum_read)
+{
+  int i;
+  uint8_t chksum = 0;
+
+  for (i = 0; i < len - 1; i++)
+    chksum += area[i];
+
+  /* Zero checksum calculation */
+  chksum = ~(chksum) + 1;
+
+  return (chksum == chksum_read) ? 0 : -1;
+}
+
+/*
+ * get_chassis_type - get the Chassis type
+ *
+ * @type_hex  : type stored in the data
+ *
+ * returns char ptr for chassis type string
+ * returns NULL if type not in the list
+ */
+static char * get_chassis_type(uint8_t type_hex)
+{
+  int type, ret;
+  char type_int[4];
+
+  ret = sprintf(type_int, "%u", type_hex);
+  type = atoi(type_int) - 1;
+
+  /* If the type is not in the list defined.*/
+  if (type > FRUID_CHASSIS_TYPECODE_MAX || type < FRUID_CHASSIS_TYPECODE_MIN) {
+    syslog(LOG_INFO, "fruid: chassis area: invalid chassis type\n");
+    return NULL;
+  }
+
+  char * type_str = (char *) malloc(strlen(fruid_chassis_type[type]));
+  if (!type_str) {
+    syslog(LOG_ALERT, "fruid: malloc: memory allocation failed\n");
+    return NULL;
+  }
+
+  memcpy(type_str, fruid_chassis_type[type], strlen(fruid_chassis_type[type]));
+
+  return type_str;
+}
+
+/*
+ * _fruid_area_field_read - read the field data
+ *
+ * @offset    : offset of the field
+ *
+ * returns char ptr for the field data string
+ */
+static char * _fruid_area_field_read(uint8_t *offset)
+{
+  int field_type, field_len, field_len_eff;
+  int idx, idx_eff, val;
+  char * field;
+
+  /* Bits 7:6 */
+  field_type = FIELD_TYPE(offset[0]);
+  /* Bits 5:0 */
+  field_len = FIELD_LEN(offset[0]);
+
+  /* Calculate the effective length of the field data based on type stored. */
+  switch (field_type) {
+
+  case TYPE_BINARY:
+    /* TODO: Need to add support to read data stored in binary type. */
+    field_len_eff = 1;
+    break;
+
+  case TYPE_ASCII_6BIT:
+    /*
+     * Every 3 bytes have four 6-bit packed values
+     * + 6-bit values from the remaining field bytes.
+     */
+    field_len_eff = (field_len / 3) * 4 + (field_len % 3);
+    break;
+
+  case TYPE_BCD_PLUS:
+  case TYPE_ASCII_8BIT:
+    field_len_eff = field_len;
+    break;
+  }
+
+  /* If field data is zero, store 'N/A' for that field. */
+  field_len_eff > 0 ? (field = (char *) malloc(field_len_eff + 1)) :
+                      (field = (char *) malloc(strlen(FIELD_EMPTY)));
+  if (!field) {
+    syslog(LOG_ALERT, "fruid: malloc: memory allocation failed\n");
+    return NULL;
+  }
+
+  memset(field, 0, field_len + 1);
+
+  if (field_len_eff < 1) {
+    strcpy(field, FIELD_EMPTY);
+    return field;
+  }
+
+  /* Retrieve field data depending on the type it was stored. */
+  switch (field_type) {
+  case TYPE_BINARY:
+   /* TODO: Need to add support to read data stored in binary type. */
+    break;
+
+  case TYPE_BCD_PLUS:
+
+    idx = 0;
+    while (idx != field_len) {
+      field[idx] = bcd_plus_array[offset[idx + 1] & 0x0F];
+      idx++;
+    }
+    field[idx] = '\0';
+    break;
+
+  case TYPE_ASCII_6BIT:
+
+    idx_eff = 0, idx = 1;
+
+    while (field_len > 0) {
+
+      /* 6-Bits => Bits 5:0 of the first byte */
+      val = offset[idx] & 0x3F;
+      field[idx_eff++] = ascii_6bit[(val & 0xF0) >> 4][val & 0x0F];
+      field_len--;
+
+      if (field_len > 0) {
+        /* 6-Bits => Bits 3:0 of second byte + Bits 7:6 of first byte. */
+        val = ((offset[idx] & 0xC0) >> 6) |
+              ((offset[idx + 1] & 0x0F) << 2);
+        field[idx_eff++] = ascii_6bit[(val & 0xF0) >> 4][val & 0x0F];
+        field_len--;
+      }
+
+      if (field_len > 0) {
+        /* 6-Bits => Bits 1:0 of third byte + Bits 7:4 of second byte. */
+        val = ((offset[idx + 1] & 0xF0) >> 4) |
+              ((offset[idx + 2] & 0x03) << 4);
+        field[idx_eff++] = ascii_6bit[(val & 0xF0) >> 4][val & 0x0F];
+
+        /* 6-Bits => Bits 7:2 of third byte. */
+        val = ((offset[idx + 2] & 0xFC) >> 2);
+        field[idx_eff++] = ascii_6bit[(val & 0xF0) >> 4][val & 0x0F];
+
+        field_len--;
+        idx += 3;
+      }
+    }
+    /* Add Null terminator */
+    field[idx_eff] = '\0';
+    break;
+
+  case TYPE_ASCII_8BIT:
+
+    memcpy(field, offset + 1, field_len);
+    /* Add Null terminator */
+    field[field_len] = '\0';
+    break;
+  }
+
+  return field;
+}
+
+/* Free all the memory allocated for fruid information */
+void free_fruid_info(fruid_info_t * fruid)
+{
+  if (fruid->chassis.flag) {
+    free(fruid->chassis.type_str);
+    free(fruid->chassis.part);
+    free(fruid->chassis.serial);
+    free(fruid->chassis.custom);
+  }
+
+  if (fruid->board.flag) {
+    free(fruid->board.mfg_time_str);
+    free(fruid->board.mfg);
+    free(fruid->board.name);
+    free(fruid->board.serial);
+    free(fruid->board.part);
+    free(fruid->board.fruid);
+  }
+
+  if (fruid->product.flag) {
+    free(fruid->board.custom);
+    free(fruid->product.mfg);
+    free(fruid->product.name);
+    free(fruid->product.part);
+    free(fruid->product.version);
+    free(fruid->product.serial);
+    free(fruid->product.asset_tag);
+    free(fruid->product.fruid);
+    free(fruid->product.custom);
+  }
+}
+
+/* Initialize the fruid information struct */
+static void init_fruid_info(fruid_info_t * fruid)
+{
+  fruid->chassis.flag = 0;
+  fruid->board.flag = 0;
+  fruid->product.flag = 0;
+  fruid->chassis.type_str = NULL;
+  fruid->chassis.part = NULL;
+  fruid->chassis.serial = NULL;
+  fruid->chassis.custom = NULL;
+  fruid->board.mfg_time_str = NULL;
+  fruid->board.mfg = NULL;
+  fruid->board.name = NULL;
+  fruid->board.serial = NULL;
+  fruid->board.part = NULL;
+  fruid->board.fruid = NULL;
+  fruid->board.custom = NULL;
+  fruid->product.mfg = NULL;
+  fruid->product.name = NULL;
+  fruid->product.part = NULL;
+  fruid->product.version = NULL;
+  fruid->product.serial = NULL;
+  fruid->product.asset_tag = NULL;
+  fruid->product.fruid = NULL;
+  fruid->product.custom = NULL;
+}
+
+/* Parse the Product area data */
+int parse_fruid_area_product(uint8_t * product,
+      fruid_area_product_t * fruid_product)
+{
+  int ret, index;
+
+  index = 0;
+
+  /* Reset the struct to zero */
+  memset(fruid_product, 0, sizeof(fruid_area_product_t));
+
+  /* Check if the format version is as per IPMI FRUID v1.0 format spec */
+  fruid_product->format_ver = product[index++];
+  if (fruid_product->format_ver != FRUID_FORMAT_VER) {
+    syslog(LOG_ERR, "fruid: product_area: format version not supported");
+    return EPROTONOSUPPORT;
+  }
+
+  fruid_product->area_len = product[index++] * FRUID_AREA_LEN_MULTIPLIER;
+  fruid_product->lang_code = product[index++];
+
+  fruid_product->chksum = product[fruid_product->area_len - 1];
+  ret = verify_chksum((uint8_t *) product,
+          fruid_product->area_len, fruid_product->chksum);
+
+  if (ret) {
+    syslog(LOG_ERR, "fruid: product_area: chksum not verified.");
+    return EBADF;
+  }
+
+  fruid_product->mfg = _fruid_area_field_read(&product[index]);
+  if (fruid_product->mfg == NULL)
+    return ENOMEM;
+  index += FIELD_LEN(product[index]) + 1;
+
+  fruid_product->name = _fruid_area_field_read(&product[index]);
+  if (fruid_product->name == NULL)
+    return ENOMEM;
+  index += FIELD_LEN(product[index]) + 1;
+
+  fruid_product->part = _fruid_area_field_read(&product[index]);
+  if (fruid_product->part == NULL)
+    return ENOMEM;
+  index += FIELD_LEN(product[index]) + 1;
+
+  fruid_product->version = _fruid_area_field_read(&product[index]);
+  if (fruid_product->version == NULL)
+    return ENOMEM;
+  index += FIELD_LEN(product[index]) + 1;
+
+  fruid_product->serial = _fruid_area_field_read(&product[index]);
+  if (fruid_product->serial == NULL)
+    return ENOMEM;
+  index += FIELD_LEN(product[index]) + 1;
+
+  fruid_product->asset_tag = _fruid_area_field_read(&product[index]);
+  if (fruid_product->asset_tag == NULL)
+    return ENOMEM;
+  index += FIELD_LEN(product[index]) + 1;
+
+  fruid_product->fruid = _fruid_area_field_read(&product[index]);
+  if (fruid_product->fruid == NULL)
+    return ENOMEM;
+  index += FIELD_LEN(product[index]) + 1;
+
+  fruid_product->custom = _fruid_area_field_read(&product[index]);
+  if (fruid_product->custom == NULL)
+    return ENOMEM;
+  index += FIELD_LEN(product[index]) + 1;
+
+  return 0;
+}
+
+/* Parse the Board area data */
+int parse_fruid_area_board(uint8_t * board,
+      fruid_area_board_t * fruid_board)
+{
+  int ret, index, i;
+  time_t unix_time;
+
+  index = 0;
+
+  /* Reset the struct to zero */
+  memset(fruid_board, 0, sizeof(fruid_area_board_t));
+
+  /* Check if the format version is as per IPMI FRUID v1.0 format spec */
+  fruid_board->format_ver = board[index++];
+  if (fruid_board->format_ver != FRUID_FORMAT_VER) {
+    syslog(LOG_ERR, "fruid: board_area: format version not supported");
+    return EPROTONOSUPPORT;
+  }
+  fruid_board->area_len = board[index++] * FRUID_AREA_LEN_MULTIPLIER;
+  fruid_board->lang_code = board[index++];
+
+  fruid_board->chksum = board[fruid_board->area_len - 1];
+  ret = verify_chksum((uint8_t *) board,
+          fruid_board->area_len, fruid_board->chksum);
+
+  if (ret) {
+    syslog(LOG_ERR, "fruid: board_area: chksum not verified.");
+    return EBADF;
+  }
+
+  for (i = 0; i < 3; i++) {
+    fruid_board->mfg_time[i] = board[index++];
+  }
+
+  fruid_board->mfg_time_str = calculate_time(fruid_board->mfg_time);
+  if (fruid_board->mfg_time_str == NULL)
+    return ENOMEM;
+
+  fruid_board->mfg = _fruid_area_field_read(&board[index]);
+  if (fruid_board->mfg == NULL)
+    return ENOMEM;
+  index += FIELD_LEN(board[index]) + 1;
+
+  fruid_board->name = _fruid_area_field_read(&board[index]);
+  if (fruid_board->name == NULL)
+    return ENOMEM;
+  index += FIELD_LEN(board[index]) + 1;
+
+  fruid_board->serial = _fruid_area_field_read(&board[index]);
+  if (fruid_board->serial == NULL)
+    return ENOMEM;
+  index += FIELD_LEN(board[index]) + 1;
+
+  fruid_board->part = _fruid_area_field_read(&board[index]);
+  if (fruid_board->part == NULL)
+    return ENOMEM;
+  index += FIELD_LEN(board[index]) + 1;
+
+  fruid_board->fruid = _fruid_area_field_read(&board[index]);
+  if (fruid_board->fruid == NULL)
+    return ENOMEM;
+  index += FIELD_LEN(board[index]) + 1;
+
+  fruid_board->custom = _fruid_area_field_read(&board[index]);
+  if (fruid_board->custom == NULL)
+    return ENOMEM;
+  index += FIELD_LEN(board[index]) + 1;
+
+  return 0;
+}
+
+/* Parse the Chassis area data */
+int parse_fruid_area_chassis(uint8_t * chassis,
+      fruid_area_chassis_t * fruid_chassis)
+{
+  int ret, index;
+
+  index = 0;
+
+  /* Reset the struct to zero */
+  memset(fruid_chassis, 0, sizeof(fruid_area_chassis_t));
+
+  /* Check if the format version is as per IPMI FRUID v1.0 format spec */
+  fruid_chassis->format_ver = chassis[index++];
+  if (fruid_chassis->format_ver != FRUID_FORMAT_VER) {
+    syslog(LOG_ERR, "fruid: chassis_area: format version not supported");
+    return EPROTONOSUPPORT;
+  }
+
+  fruid_chassis->area_len = chassis[index++] * FRUID_AREA_LEN_MULTIPLIER;
+  fruid_chassis->type = chassis[index++];
+
+  fruid_chassis->chksum = chassis[fruid_chassis->area_len - 1];
+  ret = verify_chksum((uint8_t *) chassis,
+          fruid_chassis->area_len, fruid_chassis->chksum);
+  if (ret) {
+    syslog(LOG_ERR, "fruid: chassis_area: chksum not verified.");
+    return EBADF;
+  }
+
+  fruid_chassis->type_str = get_chassis_type(fruid_chassis->type);
+  if (fruid_chassis->type_str == NULL)
+    return ENOMSG;
+
+  fruid_chassis->part = _fruid_area_field_read(&chassis[index]);
+  if (fruid_chassis->part == NULL)
+    return ENOMEM;
+  index += FIELD_LEN(chassis[index]) + 1;
+
+  fruid_chassis->serial = _fruid_area_field_read(&chassis[index]);
+  if (fruid_chassis->serial == NULL)
+    return ENOMEM;
+  index += FIELD_LEN(chassis[index]) + 1;
+
+  fruid_chassis->custom = _fruid_area_field_read(&chassis[index]);
+  if (fruid_chassis->custom == NULL)
+    return ENOMEM;
+  index += FIELD_LEN(chassis[index]) + 1;
+
+  return 0;
+}
+
+/* Calculate the area offsets and populate the fruid_eeprom_t struct */
+void set_fruid_eeprom_offsets(uint8_t * eeprom, fruid_header_t * header,
+      fruid_eeprom_t * fruid_eeprom)
+{
+  fruid_eeprom->header = eeprom + 0x00;
+
+  header->offset_area.chassis ? (fruid_eeprom->chassis = eeprom + \
+    (header->offset_area.chassis * FRUID_OFFSET_MULTIPLIER)) : \
+    (fruid_eeprom->chassis = NULL);
+
+  header->offset_area.board ? (fruid_eeprom->board = eeprom + \
+    (header->offset_area.board * FRUID_OFFSET_MULTIPLIER)) : \
+    (fruid_eeprom->board = NULL);
+
+  header->offset_area.product ? (fruid_eeprom->product = eeprom + \
+    (header->offset_area.product * FRUID_OFFSET_MULTIPLIER)) : \
+    (fruid_eeprom->product = NULL);
+
+  header->offset_area.multirecord ? (fruid_eeprom->multirecord = eeprom + \
+    (header->offset_area.multirecord * FRUID_OFFSET_MULTIPLIER)) : \
+    (fruid_eeprom->multirecord = NULL);
+}
+
+/* Populate the common header struct */
+int parse_fruid_header(uint8_t * eeprom, fruid_header_t * header)
+{
+  int ret;
+
+  memcpy((uint8_t *)header, (uint8_t *)eeprom, sizeof(fruid_header_t));
+  ret = verify_chksum((uint8_t *) header,
+          sizeof(fruid_header_t), header->chksum);
+  if (ret) {
+    syslog(LOG_ERR, "fruid: common_header: chksum not verified.");
+    return EBADF;
+  }
+
+  return ret;
+}
+
+/* Parse the eeprom dump and populate the fruid info in struct */
+int populate_fruid_info(fruid_eeprom_t * fruid_eeprom, fruid_info_t * fruid)
+{
+  int ret;
+
+  /* Initial all the required fruid structures */
+  fruid_area_chassis_t fruid_chassis;
+  fruid_area_board_t fruid_board;
+  fruid_area_product_t fruid_product;
+
+  /* If Chassis area is present, parse and print it */
+  if (fruid_eeprom->chassis) {
+    ret = parse_fruid_area_chassis(fruid_eeprom->chassis, &fruid_chassis);
+    if (!ret) {
+      fruid->chassis.flag = 1;
+      fruid->chassis.type_str = fruid_chassis.type_str;
+      fruid->chassis.part = fruid_chassis.part;
+      fruid->chassis.serial = fruid_chassis.serial;
+      fruid->chassis.custom = fruid_chassis.custom;
+    } else
+      return ret;
+  }
+
+  /* If Board area is present, parse and print it */
+  if (fruid_eeprom->board) {
+    ret = parse_fruid_area_board(fruid_eeprom->board, &fruid_board);
+    if (!ret) {
+      fruid->board.flag = 1;
+      fruid->board.mfg_time_str = fruid_board.mfg_time_str;
+      fruid->board.mfg = fruid_board.mfg;
+      fruid->board.name = fruid_board.name;
+      fruid->board.serial = fruid_board.serial;
+      fruid->board.part = fruid_board.part;
+      fruid->board.fruid = fruid_board.fruid;
+      fruid->board.custom = fruid_board.custom;
+    } else
+      return ret;
+  }
+
+  /* If Product area is present, parse and print it */
+  if (fruid_eeprom->product) {
+    ret = parse_fruid_area_product(fruid_eeprom->product, &fruid_product);
+    if (!ret) {
+      fruid->product.flag = 1;
+      fruid->product.mfg = fruid_product.mfg;
+      fruid->product.name = fruid_product.name;
+      fruid->product.part = fruid_product.part;
+      fruid->product.version = fruid_product.version;
+      fruid->product.serial = fruid_product.serial;
+      fruid->product.asset_tag = fruid_product.asset_tag;
+      fruid->product.fruid = fruid_product.fruid;
+      fruid->product.custom = fruid_product.custom;
+    } else
+      return ret;
+  }
+
+  return 0;
+}
+
+/*
+ * fruid_parse - To parse the bin file (eeprom) and populate
+ *               the fruid information in the struct
+ * @bin       : Eeprom binary file
+ * @fruid     : ptr to the struct that holds the fruid information
+ *
+ * returns 0 on success
+ * returns non-zero errno value on error
+ */
+int fruid_parse(const char * bin, fruid_info_t * fruid)
+{
+  int fruid_len, ret;
+  FILE *fruid_fd;
+  uint8_t * eeprom;
+
+  /* Initial all the required fruid structures */
+  fruid_header_t fruid_header;
+  fruid_eeprom_t fruid_eeprom;
+
+  memset(&fruid_header, 0, sizeof(fruid_header_t));
+  memset(&fruid_eeprom, 0, sizeof(fruid_eeprom_t));
+
+  /* Reset parser return value */
+  ret = 0;
+
+  /* Open the FRUID binary file */
+  fruid_fd = fopen(bin, "rb");
+  if (!fruid_fd) {
+    syslog(LOG_ERR, "fruid: unable to open the file");
+    return ENOENT;
+  }
+
+  /* Get the size of the binary file */
+  fseek(fruid_fd, 0, SEEK_END);
+  fruid_len = (uint32_t) ftell(fruid_fd);
+
+  fseek(fruid_fd, 0, SEEK_SET);
+
+  eeprom = (uint8_t *) malloc(fruid_len);
+  if (!eeprom) {
+    syslog(LOG_ALERT, "fruid: malloc: memory allocation failed\n");
+    return ENOMEM;
+  }
+
+  /* Read the binary file */
+  fread(eeprom, sizeof(uint8_t), fruid_len, fruid_fd);
+
+  /* Close the FRUID binary file */
+  fclose(fruid_fd);
+
+  /* Parse the common header data */
+  ret = parse_fruid_header(eeprom, &fruid_header);
+  if (ret) {
+    /* Free the eeprom malloc'ed memory */
+    free(eeprom);
+    return ret;
+  }
+
+  /* Calculate all the area offsets */
+  set_fruid_eeprom_offsets(eeprom, &fruid_header, &fruid_eeprom);
+
+  init_fruid_info(fruid);
+  /* Parse the eeprom and populate the fruid information */
+  ret = populate_fruid_info(&fruid_eeprom, fruid);
+  if (ret) {
+    /* Free the malloced memory for the fruid information */
+    free_fruid_info(fruid);
+  }
+
+  /* Free the eeprom malloced memory */
+  free(eeprom);
+
+  return ret;
+}