pseq: Create UCD90320Device class
Create the UCD90320Device class in the phosphor-power-sequencer
application.
This class represents the UCD90320 power sequencer device.
Change-Id: I697644d4c52019be045286a5598023602b7fc4d6
Signed-off-by: Shawn McCarney <shawnmm@us.ibm.com>
diff --git a/phosphor-power-sequencer/src/meson.build b/phosphor-power-sequencer/src/meson.build
index 02084c9..1f6c04c 100644
--- a/phosphor-power-sequencer/src/meson.build
+++ b/phosphor-power-sequencer/src/meson.build
@@ -10,6 +10,7 @@
'rail.cpp',
'services.cpp',
'standard_device.cpp',
+ 'ucd90320_device.cpp',
'ucd90x_device.cpp',
implicit_include_directories: false,
dependencies: [
diff --git a/phosphor-power-sequencer/src/ucd90320_device.cpp b/phosphor-power-sequencer/src/ucd90320_device.cpp
new file mode 100644
index 0000000..2d91797
--- /dev/null
+++ b/phosphor-power-sequencer/src/ucd90320_device.cpp
@@ -0,0 +1,82 @@
+/**
+ * Copyright © 2024 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 "ucd90320_device.hpp"
+
+#include "format_utils.hpp"
+#include "standard_device.hpp"
+
+#include <array>
+#include <format>
+#include <span>
+
+namespace phosphor::power::sequencer
+{
+
+/**
+ * Group of GPIO values that should be formatted together.
+ */
+struct GPIOGroup
+{
+ std::string additionalDataName;
+ std::string journalName;
+ unsigned int offset;
+ unsigned int count;
+};
+
+/**
+ * UCD90320-specific groups of GPIO values.
+ *
+ * The offsets correspond to the Pin IDs defined in the UCD90320 PMBus interface
+ * documentation. These Pin IDs are the same as the libgpiod line offsets used
+ * to obtain the GPIO values.
+ */
+static const std::array<GPIOGroup, 5> gpioGroups = {
+ GPIOGroup{"MAR01_24_GPIO_VALUES", "MAR01-24", 0, 24},
+ GPIOGroup{"EN1_32_GPIO_VALUES", "EN1-32", 24, 32},
+ GPIOGroup{"LGP01_16_GPIO_VALUES", "LGP01-16", 56, 16},
+ GPIOGroup{"DMON1_8_GPIO_VALUES", "DMON1-8", 72, 8},
+ GPIOGroup{"GPIO1_4_GPIO_VALUES", "GPIO1-4", 80, 4}};
+
+void UCD90320Device::storeGPIOValues(
+ Services& services, const std::vector<int>& values,
+ std::map<std::string, std::string>& additionalData)
+{
+ // Verify the expected number of GPIO values were passed in
+ unsigned int expectedCount = gpioGroups.back().offset +
+ gpioGroups.back().count;
+ if (values.size() != expectedCount)
+ {
+ // Unexpected number of values; store as a plain list of integers
+ StandardDevice::storeGPIOValues(services, values, additionalData);
+ return;
+ }
+
+ // Store GPIO groups in additional data and journal
+ services.logInfoMsg(std::format("Device {} GPIO values:", name));
+ auto span = std::span{values};
+ std::string valuesStr;
+ for (const GPIOGroup& group : gpioGroups)
+ {
+ valuesStr =
+ format_utils::toString(span.subspan(group.offset, group.count));
+ additionalData.emplace(group.additionalDataName, valuesStr);
+ services.logInfoMsg(
+ std::format("{}: {}", group.journalName, valuesStr));
+ }
+}
+
+} // namespace phosphor::power::sequencer
diff --git a/phosphor-power-sequencer/src/ucd90320_device.hpp b/phosphor-power-sequencer/src/ucd90320_device.hpp
new file mode 100644
index 0000000..c52c6ce
--- /dev/null
+++ b/phosphor-power-sequencer/src/ucd90320_device.hpp
@@ -0,0 +1,70 @@
+/**
+ * Copyright © 2024 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.
+ */
+#pragma once
+
+#include "rail.hpp"
+#include "services.hpp"
+#include "ucd90x_device.hpp"
+
+#include <cstdint>
+#include <map>
+#include <memory>
+#include <string>
+#include <utility>
+#include <vector>
+
+namespace phosphor::power::sequencer
+{
+
+/**
+ * @class UCD90320Device
+ *
+ * Class representing the UCD90320 power sequencer device.
+ */
+class UCD90320Device : public UCD90xDevice
+{
+ public:
+ // Specify which compiler-generated methods we want
+ UCD90320Device() = delete;
+ UCD90320Device(const UCD90320Device&) = delete;
+ UCD90320Device(UCD90320Device&&) = delete;
+ UCD90320Device& operator=(const UCD90320Device&) = delete;
+ UCD90320Device& operator=(UCD90320Device&&) = delete;
+ virtual ~UCD90320Device() = default;
+
+ /**
+ * Constructor.
+ *
+ * @param rails Voltage rails that are enabled and monitored by this device
+ * @param services System services like hardware presence and the journal
+ * @param bus I2C bus for the device
+ * @param address I2C address for the device
+ */
+ explicit UCD90320Device(std::vector<std::unique_ptr<Rail>> rails,
+ Services& services, uint8_t bus, uint16_t address) :
+ UCD90xDevice(deviceName, std::move(rails), services, bus, address)
+ {}
+
+ constexpr static std::string deviceName{"UCD90320"};
+
+ protected:
+ /** @copydoc UCD90xDevice::storeGPIOValues() */
+ virtual void storeGPIOValues(
+ Services& services, const std::vector<int>& values,
+ std::map<std::string, std::string>& additionalData) override;
+};
+
+} // namespace phosphor::power::sequencer