vpd-tool: Add module VPD sanity check

Added one new option to vpd-tool to do the santity check for all
the module vpds. It takes one at a time and checks for it's header,
TOC and all it's records.

Test:
./vpd-tool -h

 --sanityCheck  Do the sanity check for module vpd. It validates primary eeprom and then redundant eeprom
...
Module vpd sanity check:
    vpd-tool --sanityCheck

./vpd-tool --sanityCheck
DBG: received file path:/sys/bus/spi/drivers/at25/spi12.0/eeprom
DBG: Processing all records
DBG: received file path:/sys/bus/spi/drivers/at25/spi13.0/eeprom
DBG: Processing all records

Signed-off-by: Alpana Kumari <[email protected]>

Author: Alpana07

meson.build

@@ -61,6 +61,18 @@ configure_file(output: 'config.h', configuration: conf_data)
 
 services = ['service_files/vpd-manager.service']
 
+libgpiodcxx = dependency('libgpiodcxx', default_options: ['bindings=cxx'])
+
+libvpdecc_src = files('vpdecc/vpdecc.c', 'vpdecc/vpdecc_support.c')
+
+libvpdecc = shared_library(
+    'vpdecc',
+    libvpdecc_src,
+    version: meson.project_version(),
+    install: true,
+)
+
+
 if get_option('ibm_system').allowed()
     subdir('vpd-tool')
     scripts = ['scripts/wait-vpd-status.sh']
@@ -85,17 +97,6 @@ if get_option('ibm_system').allowed()
     )
 endif
 
-libgpiodcxx = dependency('libgpiodcxx', default_options: ['bindings=cxx'])
-
-libvpdecc_src = files('vpdecc/vpdecc.c', 'vpdecc/vpdecc_support.c')
-
-libvpdecc = shared_library(
-    'vpdecc',
-    libvpdecc_src,
-    version: meson.project_version(),
-    install: true,
-)
-
 subdir('vpd-manager')
 
 systemd_system_unit_dir = dependency('systemd').get_variable(

vpd-tool/include/tool_types.hpp

@@ -113,5 +113,15 @@ using BiosAttributeMetaData = std::tuple<std::string, uint8_t, std::optional<uin
 //{Record, Keyword} -> {attribute name, number of bits in keyword, starting bit
 // position, enabled value, disabled value}
 using BiosAttributeKeywordMap = std::unordered_map<IpzType,std::vector<BiosAttributeMetaData>,IpzKeyHash,IpzKeyEqual>;
+
+using KwSize = uint8_t;
+using RecordId = uint8_t;
+using RecordSize = uint16_t;
+using RecordType = uint16_t;
+using RecordOffset = uint16_t;
+using RecordLength = uint16_t;
+using ECCOffset = uint16_t;
+using ECCLength = uint16_t;
+
 } // namespace types
 } // namespace vpd

vpd-tool/include/tool_utils.hpp

@@ -996,5 +996,45 @@ inline types::BinaryVector convertIntegralTypeToBytes(
     return l_result;
 }
 
+/**
+ * @brief An API to get VPD in a vector.
+ *
+ * The vector is required by the respective parser to fill the VPD map.
+ * Note: API throws exception in case of failure. Caller needs to handle.
+ *
+ * @param[in] vpdFilePath - EEPROM path of the FRU.
+ * @param[out] vpdVector - VPD in vector form.
+ * @param[in] vpdStartOffset - Offset of VPD data in EEPROM.
+ */
+inline void getVpdDataInVector(const std::string& vpdFilePath,
+                               types::BinaryVector& vpdVector,
+                               size_t& vpdStartOffset)
+{
+    try
+    {
+        std::fstream vpdFileStream;
+        vpdFileStream.exceptions(
+            std::ifstream::badbit | std::ifstream::failbit);
+        vpdFileStream.open(vpdFilePath, std::ios::in | std::ios::binary);
+        auto vpdSizeToRead = std::min(std::filesystem::file_size(vpdFilePath),
+                                      static_cast<uintmax_t>(65504));
+        vpdVector.resize(vpdSizeToRead);
+
+        vpdFileStream.seekg(vpdStartOffset, std::ios_base::beg);
+        vpdFileStream.read(reinterpret_cast<char*>(&vpdVector[0]),
+                           vpdSizeToRead);
+
+        vpdVector.resize(vpdFileStream.gcount());
+        vpdFileStream.clear(std::ios_base::eofbit);
+    }
+    catch (const std::ifstream::failure& fail)
+    {
+        std::cerr << "Exception in file handling [" << vpdFilePath
+                  << "] error : " << fail.what();
+        throw;
+    }
+}
+
+
 } // namespace utils
 } // namespace vpd

vpd-tool/include/vpd_tool.hpp

@@ -371,5 +371,68 @@ class VpdTool
      * the directory from the filesystem
      */
     void clearVpdDumpDir() const noexcept;
+
+    /**
+     * @brief Check ECC of VPD header.
+     *
+     * @param[in] l_vpdVector - vpd vector to fetch the data.
+     * @return true/false based on check result.
+     */
+    bool vhdrEccCheck(const types::BinaryVector l_vpdVector);
+
+    /**
+     * @brief API to check validity of VPD header.
+     *
+     * @param[in] itrToVPD - Iterator to the beginning of VPD file.
+     * @param[in] l_vpdVector - vpd vector to fetch the data.
+     */
+    void checkHeader(types::BinaryVector::const_iterator itrToVPD, const types::BinaryVector l_vpdVector);
+
+    /**
+     * @brief Check ECC of VTOC.
+     *
+     * @param[in] l_vpdVector - vpd vector to fetch the data.
+     * @return true/false based on check result.
+     */
+    bool vtocEccCheck(const types::BinaryVector l_vpdVector);
+
+    /**
+     * @brief API to read VTOC record.
+     *
+     * The API reads VTOC record and returns the length of PT keyword.
+     *
+     * @param[in] itrToVPD - Iterator to begining of VPD data.
+     * @param[in] l_vpdVector - vpd vector to fetch the data.
+     * @return Length of PT keyword.
+     */
+    auto readTOC(types::BinaryVector::const_iterator& itrToVPD,const types::BinaryVector l_vpdVector);
+
+    /**
+     * @brief Check ECC of a record.
+     *
+     * @param[in] iterator - Iterator to the record.
+     * @param[in] l_vpdVector - vpd vector to fetch the data.
+     * @return success/failure
+     */
+    bool recordEccCheck(types::BinaryVector::const_iterator iterator, const types::BinaryVector l_vpdVector);
+
+    /**
+     * @brief API to read PT record.
+     *
+     * @param[in] itrToPT - Iterator to PT record in VPD vector.
+     * @param[in] l_vpdVector - vpd vector to fetch the data.
+     * @param[in] ptLength - length of the PT record.
+     * @return success/failure.
+     */
+    uint8_t readPT(types::BinaryVector::const_iterator& itrToPT,
+                    const types::BinaryVector l_vpdVector,
+                         auto ptLength);
+    /**
+     * @brief API to perform sanity check EEPROM.
+     *
+     * @param[in] eepromPath - vpd path to perform sanity check
+     * @return SUCCESS or FAILURE.
+     */
+    uint8_t performSanityCheck(const std::string& eepromPath);
 };
 } // namespace vpd