include/utility/common_utility.hpp

22  *                  | Commmon Utility | - - - - - - -
32  *               | Vpd specific Utility | - - - - - - -
44  * @param[in] i_errCode - error code.
61  * @param [in] i_aByte - The input byte.
62  * @returns Null character if input byte is out of bound else returns hex
102  * @param[out] o_errCode - To set error code in case of error.
124             Logger::getLoggerInstance()->logMessage(  in executeCmd()
138         Logger::getLoggerInstance()->logMessage(  in executeCmd()
148  * @param [in] i_string - Input string.
159  * The API returns the hex represented value of the given input in string format
162  * @param[in] i_keywordValue - Vector of input byte.
164  * @return - Returns the converted string value.
184  * the input data will be returned. Otherwise if the data has any non-printable
187  * @param[in] i_keywordValue - Data in binary format.
188  * @param[out] o_errCode - To set error code in case of error.
190  * @return - Returns the converted string value.
231  * @param[in] i_value - Input data.
232  * @param[out] o_errCode - To set error code in case of error.
234  * @return - Array of binary data on success, empty vector in case of error.
288         Logger::getLoggerInstance()->logMessage(  in convertToBinary()
314  * @brief API to check is field mode enabled.
316  * @param[out] o_errCode - To set error code in case of error.
318  * @return true, if field mode is enabled. otherwise false.
333             l_cmdOutput[0].erase(l_cmdOutput[0].length() - 1);  in isFieldModeEnabled()
340         Logger::getLoggerInstance()->logMessage(  in isFieldModeEnabled()
341             "Failed to check if field mode is enabled, error : " +  in isFieldModeEnabled()
349  * @brief API to get VPD collection mode
351  * VPD collection mode can be hardware, mixed mode or file mode. This is
352  * determined by reading a u-boot variable.
354  * @param[out] o_errCode - To set error code in case of error.
356  * @return Hardware mode, mixed mode or file mode.
373             l_cmdOutput[0].erase(l_cmdOutput[0].length() - 1);  in getVpdCollectionMode()
400  * API to get effective VPD path for a FRU based on the VPD collection mode.
402  * @param[in] i_vpdCollectionMode - VPD collection mode.
403  * @param[in,out] io_fruPath - Path to the EEPROM file.
404  * @param[out] o_errCode - To set error code in case of error.
419         // For Hardware mode and mixed mode FRU path is considered as EEPROM  in getEffectiveFruPath()
422         // ToDo: Need to handle path for mixed mode, when mixed mode is fully  in getEffectiveFruPath()
428         Logger::getLoggerInstance()->logMessage(  in getEffectiveFruPath()