regulators: Implement i2c_capture_bytes action
Implement the new i2c_capture_bytes action in the JSON configuration
file.
Create gtests to test the new class.
Signed-off-by: Shawn McCarney <shawnmm@us.ibm.com>
Change-Id: Ie43e147a0a076090729871140bb5889c74323d19
diff --git a/phosphor-regulators/src/actions/i2c_capture_bytes_action.cpp b/phosphor-regulators/src/actions/i2c_capture_bytes_action.cpp
new file mode 100644
index 0000000..728daeb
--- /dev/null
+++ b/phosphor-regulators/src/actions/i2c_capture_bytes_action.cpp
@@ -0,0 +1,78 @@
+/**
+ * Copyright © 2021 IBM 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 "i2c_capture_bytes_action.hpp"
+
+#include "action_error.hpp"
+#include "i2c_interface.hpp"
+
+#include <exception>
+#include <ios>
+#include <sstream>
+
+namespace phosphor::power::regulators
+{
+
+bool I2CCaptureBytesAction::execute(ActionEnvironment& environment)
+{
+ try
+ {
+ // Read device register values. Use I2C mode where the number of bytes
+ // to read is explicitly specified.
+ i2c::I2CInterface& interface = getI2CInterface(environment);
+ uint8_t size{count}; // byte count parameter is input/output
+ uint8_t values[UINT8_MAX];
+ interface.read(reg, size, values, i2c::I2CInterface::Mode::I2C);
+
+ // Build additional error data key
+ std::ostringstream kss;
+ kss << environment.getDeviceID() << "_register_0x" << std::hex
+ << std::uppercase << static_cast<uint16_t>(reg);
+ std::string key = kss.str();
+
+ // Build additional error data value
+ std::ostringstream vss;
+ vss << "[ " << std::hex << std::uppercase;
+ for (unsigned int i = 0; i < count; ++i)
+ {
+ vss << ((i > 0) ? ", " : "") << "0x"
+ << static_cast<uint16_t>(values[i]);
+ }
+ vss << " ]";
+ std::string value = vss.str();
+
+ // Store additional error data in action environment
+ environment.addAdditionalErrorData(key, value);
+ }
+ catch (const i2c::I2CException& e)
+ {
+ // Nest I2CException within an ActionError so caller will have both the
+ // low level I2C error information and the action information
+ std::throw_with_nested(ActionError(*this));
+ }
+ return true;
+}
+
+std::string I2CCaptureBytesAction::toString() const
+{
+ std::ostringstream ss;
+ ss << "i2c_capture_bytes: { register: 0x" << std::hex << std::uppercase
+ << static_cast<uint16_t>(reg) << ", count: " << std::dec
+ << static_cast<uint16_t>(count) << " }";
+ return ss.str();
+}
+
+} // namespace phosphor::power::regulators