diff options
author | AppaRao Puli <apparao.puli@linux.intel.com> | 2019-07-05 12:53:50 +0300 |
---|---|---|
committer | AppaRao Puli <apparao.puli@linux.intel.com> | 2019-07-19 18:03:44 +0300 |
commit | f95328843ca04aa746f5bd8585f1d86c2ef84df7 (patch) | |
tree | a5f3d526671c59a46cad70981fac91b4ad29acfb /intel-pfr-manager | |
parent | ec22471baaac04eae1192f6d4cf2f071a804a3ae (diff) | |
download | provingground-f95328843ca04aa746f5bd8585f1d86c2ef84df7.tar.xz |
Added library support for CPLD communication
Added library support for CPLD communciation. This library exposes
the API's used for fetching the versions(bmc/bios/cpld active & recovery)
information from CPLD.
Tested:
Loadded this library as part of intel pfr manager service(other commit)
and verified functionality.
Change-Id: Ibeffd183cacd9d5cc528665eabe4a7ecb5ef7e6a
Signed-off-by: AppaRao Puli <apparao.puli@linux.intel.com>
Diffstat (limited to 'intel-pfr-manager')
-rw-r--r-- | intel-pfr-manager/.clang-format | 84 | ||||
-rw-r--r-- | intel-pfr-manager/CMakeLists.txt | 7 | ||||
-rw-r--r-- | intel-pfr-manager/LICENSE | 201 | ||||
-rw-r--r-- | intel-pfr-manager/libpfr/CMakeLists.txt | 15 | ||||
-rw-r--r-- | intel-pfr-manager/libpfr/inc/file.hpp | 107 | ||||
-rw-r--r-- | intel-pfr-manager/libpfr/inc/pfr.hpp | 38 | ||||
-rw-r--r-- | intel-pfr-manager/libpfr/src/pfr.cpp | 144 |
7 files changed, 596 insertions, 0 deletions
diff --git a/intel-pfr-manager/.clang-format b/intel-pfr-manager/.clang-format new file mode 100644 index 0000000..37469de --- /dev/null +++ b/intel-pfr-manager/.clang-format @@ -0,0 +1,84 @@ +--- +Language: Cpp +# BasedOnStyle: LLVM +AccessModifierOffset: -2 +AlignAfterOpenBracket: Align +AlignConsecutiveAssignments: false +AlignConsecutiveDeclarations: false +AlignEscapedNewlinesLeft: false +AlignOperands: true +AlignTrailingComments: true +AllowAllParametersOfDeclarationOnNextLine: true +AllowShortBlocksOnASingleLine: false +AllowShortCaseLabelsOnASingleLine: false +AllowShortFunctionsOnASingleLine: None +AllowShortIfStatementsOnASingleLine: false +AllowShortLoopsOnASingleLine: false +AlwaysBreakAfterDefinitionReturnType: None +AlwaysBreakAfterReturnType: None +AlwaysBreakBeforeMultilineStrings: false +AlwaysBreakTemplateDeclarations: false +BinPackArguments: true +BinPackParameters: true +BraceWrapping: + AfterClass: true + AfterControlStatement: true + AfterEnum: true + AfterFunction: true + AfterNamespace: true + AfterObjCDeclaration: true + AfterStruct: true + AfterUnion: true + BeforeCatch: true + BeforeElse: true + IndentBraces: false +BreakBeforeBinaryOperators: None +BreakBeforeBraces: Custom +BreakBeforeTernaryOperators: true +BreakConstructorInitializers: AfterColon +ColumnLimit: 80 +CommentPragmas: '^ IWYU pragma:' +ConstructorInitializerAllOnOneLineOrOnePerLine: false +ConstructorInitializerIndentWidth: 4 +ContinuationIndentWidth: 4 +Cpp11BracedListStyle: true +DerivePointerAlignment: true +PointerAlignment: Left +DisableFormat: false +ExperimentalAutoDetectBinPacking: false +FixNamespaceComments: true +ForEachMacros: [ foreach, Q_FOREACH, BOOST_FOREACH ] +IndentCaseLabels: true +IndentWidth: 4 +IndentWrappedFunctionNames: true +KeepEmptyLinesAtTheStartOfBlocks: true +MacroBlockBegin: '' +MacroBlockEnd: '' +MaxEmptyLinesToKeep: 1 +NamespaceIndentation: None +ObjCBlockIndentWidth: 2 +ObjCSpaceAfterProperty: false +ObjCSpaceBeforeProtocolList: true +PenaltyBreakBeforeFirstCallParameter: 19 +PenaltyBreakComment: 300 +PenaltyBreakFirstLessLess: 120 +PenaltyBreakString: 1000 +PenaltyExcessCharacter: 1000000 +PenaltyReturnTypeOnItsOwnLine: 60 +PointerAlignment: Right +ReflowComments: true +SortIncludes: false +SpaceAfterCStyleCast: false +SpaceBeforeAssignmentOperators: true +SpaceBeforeParens: ControlStatements +SpaceInEmptyParentheses: false +SpacesBeforeTrailingComments: 1 +SpacesInAngles: false +SpacesInContainerLiterals: true +SpacesInCStyleCastParentheses: false +SpacesInParentheses: false +SpacesInSquareBrackets: false +Standard: Cpp11 +TabWidth: 4 +UseTab: Never +... diff --git a/intel-pfr-manager/CMakeLists.txt b/intel-pfr-manager/CMakeLists.txt new file mode 100644 index 0000000..970d237 --- /dev/null +++ b/intel-pfr-manager/CMakeLists.txt @@ -0,0 +1,7 @@ +cmake_minimum_required(VERSION 2.8.10 FATAL_ERROR) +set(CMAKE_CXX_STANDARD 17) +set(CMAKE_CXX_STANDARD_REQUIRED ON) + +include_directories(${CMAKE_CURRENT_SOURCE_DIR}/libpfr/inc) + +add_subdirectory(libpfr) diff --git a/intel-pfr-manager/LICENSE b/intel-pfr-manager/LICENSE new file mode 100644 index 0000000..8dada3e --- /dev/null +++ b/intel-pfr-manager/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/intel-pfr-manager/libpfr/CMakeLists.txt b/intel-pfr-manager/libpfr/CMakeLists.txt new file mode 100644 index 0000000..8957c9f --- /dev/null +++ b/intel-pfr-manager/libpfr/CMakeLists.txt @@ -0,0 +1,15 @@ +cmake_minimum_required(VERSION 2.8.10 FATAL_ERROR) +project(pfr CXX) +set(CMAKE_CXX_STANDARD 17) +set(CMAKE_CXX_STANDARD_REQUIRED ON) + +include(ExternalProject) +include_directories(${CMAKE_CURRENT_SOURCE_DIR}/inc) + +add_library(${PROJECT_NAME} SHARED src/pfr.cpp) + +set_target_properties(${PROJECT_NAME} PROPERTIES VERSION "0.1.0") +set_target_properties(${PROJECT_NAME} PROPERTIES SOVERSION "0") +target_link_libraries(${PROJECT_NAME} phosphor_logging) + +install(TARGETS ${PROJECT_NAME} DESTINATION ${CMAKE_INSTALL_LIBDIR}) diff --git a/intel-pfr-manager/libpfr/inc/file.hpp b/intel-pfr-manager/libpfr/inc/file.hpp new file mode 100644 index 0000000..c7ef58c --- /dev/null +++ b/intel-pfr-manager/libpfr/inc/file.hpp @@ -0,0 +1,107 @@ +/* +// Copyright (c) 2019 Intel Corporation +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +*/ + +#pragma once + +#include <errno.h> +#include <fcntl.h> +#include <sys/ioctl.h> +#include <stdio.h> +#include <experimental/filesystem> +#include <phosphor-logging/log.hpp> + +extern "C" { +#include <i2c/smbus.h> +#include <linux/i2c-dev.h> +} + +namespace intel +{ +namespace pfr +{ + +/** @class I2CFile + * @brief Responsible for handling file pointer + */ +class I2CFile +{ + private: + /** @brief handler for operating on file */ + int fd; + + public: + I2CFile() = delete; + I2CFile(const I2CFile&) = delete; + I2CFile& operator=(const I2CFile&) = delete; + I2CFile(I2CFile&&) = delete; + I2CFile& operator=(I2CFile&&) = delete; + + /** @brief Opens i2c device file and sets slave + * + * @param[in] i2cBus - I2C bus number + * @param[in] slaveAddr - I2C slave address + * @param[in] flags - Flags + */ + I2CFile(const int& i2cBus, const int& slaveAddr, const int& flags) + { + std::string i2cDev = "/dev/i2c-" + std::to_string(i2cBus); + + fd = open(i2cDev.c_str(), flags); + if (fd < 0) + { + throw std::runtime_error("Unable to open i2c device."); + } + + if (ioctl(fd, I2C_SLAVE_FORCE, slaveAddr) < 0) + { + close(fd); + fd = -1; + throw std::runtime_error("Unable to set i2c slave address."); + } + } + + /** @brief Reads the byte data from I2C dev + * + * @param[in] Offset - Offset value + * @param[out] byte data - Offset value + */ + uint8_t i2cReadByteData(const uint8_t& offset) + { + uint8_t value = i2c_smbus_read_byte_data(fd, offset); + + if (value < 0) + { + throw std::runtime_error("i2c_smbus_read_byte_data() failed"); + } + return value; + } + + ~I2CFile() + { + if (!(fd < 0)) + { + close(fd); + } + } + + auto operator()() + { + return fd; + } +}; + +} // namespace pfr +} // namespace intel diff --git a/intel-pfr-manager/libpfr/inc/pfr.hpp b/intel-pfr-manager/libpfr/inc/pfr.hpp new file mode 100644 index 0000000..bc1f3df --- /dev/null +++ b/intel-pfr-manager/libpfr/inc/pfr.hpp @@ -0,0 +1,38 @@ +/* +// Copyright (c) 2019 Intel Corporation +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +*/ +#pragma once + +#include <string> + +namespace intel +{ +namespace pfr +{ + +enum class ImageType +{ + cpld, + biosActive, + biosRecovery, + bmcActive, + bmcRecovery +}; + +std::string getVersionInfoCPLD(ImageType &imgType); +int getProvisioningStatus(bool &ufmLocked, bool &ufmProvisioned); + +} // namespace pfr +} // namespace intel diff --git a/intel-pfr-manager/libpfr/src/pfr.cpp b/intel-pfr-manager/libpfr/src/pfr.cpp new file mode 100644 index 0000000..59929a2 --- /dev/null +++ b/intel-pfr-manager/libpfr/src/pfr.cpp @@ -0,0 +1,144 @@ +/* +// Copyright (c) 2019 Intel Corporation +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +*/ + +#include <unistd.h> +#include <iostream> +#include <sstream> +#include <iomanip> +#include "pfr.hpp" +#include "file.hpp" + +namespace intel +{ +namespace pfr +{ +// TODO: Dynamically pull these values from configuration +// entity-manager, when needed +static constexpr int i2cBusNumber = 4; +static constexpr int i2cSlaveAddress = 0x70; + +// CPLD mailbox registers +static constexpr uint8_t cpldROTVersion = 0x01; +static constexpr uint8_t cpldROTSvn = 0x02; +static constexpr uint8_t platformState = 0x03; +static constexpr uint8_t recoveryCount = 0x04; +static constexpr uint8_t lastRecoveryReason = 0x05; +static constexpr uint8_t panicEventCount = 0x06; +static constexpr uint8_t panicEventReason = 0x07; +static constexpr uint8_t majorErrorCode = 0x08; +static constexpr uint8_t minorErrorCode = 0x09; +static constexpr uint8_t provisioningStatus = 0x0A; +static constexpr uint8_t pchActiveMajorVersion = 0x17; +static constexpr uint8_t pchActiveMinorVersion = 0x18; +static constexpr uint8_t bmcActiveMajorVersion = 0x19; +static constexpr uint8_t bmcActiveMinorVersion = 0x1A; +static constexpr uint8_t pchRecoveryMajorVersion = 0x1C; +static constexpr uint8_t pchRecoveryMinorVersion = 0x1D; +static constexpr uint8_t bmcRecoveryMajorVersion = 0x1E; +static constexpr uint8_t bmcRecoveryMinorVersion = 0x1F; + +static constexpr uint8_t ufmLockedMask = (0x1 << 0x04); +static constexpr uint8_t ufmProvisionedMask = (0x1 << 0x05); + +template <typename T> std::string int_to_hexstring(T i) +{ + std::stringstream stream; + stream << std::setfill('0') << std::setw(sizeof(T) * 2) << std::hex + << static_cast<int>(i); + return stream.str(); +} + +std::string getVersionInfoCPLD(ImageType& imgType) +{ + try + { + uint8_t majorReg; + uint8_t minorReg; + + switch (imgType) + { + case (ImageType::cpld): + { + majorReg = cpldROTVersion; + minorReg = cpldROTSvn; + break; + } + case (ImageType::biosActive): + { + majorReg = pchActiveMajorVersion; + minorReg = pchActiveMinorVersion; + break; + } + case (ImageType::biosRecovery): + { + majorReg = pchRecoveryMajorVersion; + minorReg = pchRecoveryMinorVersion; + break; + } + case (ImageType::bmcActive): + { + majorReg = bmcActiveMajorVersion; + minorReg = bmcActiveMinorVersion; + break; + } + case (ImageType::bmcRecovery): + { + majorReg = bmcRecoveryMajorVersion; + minorReg = bmcRecoveryMinorVersion; + break; + } + default: + // Invalid image Type. + return ""; + } + + I2CFile cpldDev(i2cBusNumber, i2cSlaveAddress, O_RDWR | O_CLOEXEC); + uint8_t majorVer = cpldDev.i2cReadByteData(majorReg); + uint8_t minorVer = cpldDev.i2cReadByteData(minorReg); + std::string version = + int_to_hexstring(majorVer) + "." + int_to_hexstring(minorVer); + return version; + } + catch (const std::exception& e) + { + phosphor::logging::log<phosphor::logging::level::ERR>( + "Exception caught in getVersionInfoCPLD.", + phosphor::logging::entry("MSG=%s", e.what())); + return ""; + } +} + +int getProvisioningStatus(bool& ufmLocked, bool& ufmProvisioned) +{ + try + { + I2CFile cpldDev(i2cBusNumber, i2cSlaveAddress, O_RDWR | O_CLOEXEC); + uint8_t provStatus = cpldDev.i2cReadByteData(provisioningStatus); + ufmLocked = (provStatus & ufmLockedMask); + ufmProvisioned = (provStatus & ufmProvisionedMask); + return 0; + } + catch (const std::exception& e) + { + phosphor::logging::log<phosphor::logging::level::ERR>( + "Exception caught in getProvisioningStatus.", + phosphor::logging::entry("MSG=%s", e.what())); + return -1; + } +} + +} // namespace pfr +} // namespace intel |