Add UCD90160 class
This class represents the UCD90160 power sequencer
chip, and provides the ability to check that chip for
voltage and PGOOD faults.
This commit just adds function stubs.
Change-Id: Iec6e83e9bcddbd476bdd86a887db08f5875f11cd
Signed-off-by: Matt Spinler <spinler@us.ibm.com>
diff --git a/power-sequencer/ucd90160.hpp b/power-sequencer/ucd90160.hpp
new file mode 100644
index 0000000..6457396
--- /dev/null
+++ b/power-sequencer/ucd90160.hpp
@@ -0,0 +1,108 @@
+#pragma once
+
+#include <algorithm>
+#include <map>
+#include <vector>
+#include "device.hpp"
+#include "pmbus.hpp"
+#include "types.hpp"
+
+namespace witherspoon
+{
+namespace power
+{
+
+/**
+ * @class UCD90160
+ *
+ * This class implements fault analysis for the UCD90160
+ * power sequencer device.
+ *
+ */
+class UCD90160 : public Device
+{
+ public:
+
+ UCD90160() = delete;
+ ~UCD90160() = default;
+ UCD90160(const UCD90160&) = delete;
+ UCD90160& operator=(const UCD90160&) = delete;
+ UCD90160(UCD90160&&) = default;
+ UCD90160& operator=(UCD90160&&) = default;
+
+ /**
+ * Constructor
+ *
+ * @param[in] instance - the device instance number
+ */
+ UCD90160(size_t instance);
+
+ /**
+ * Analyzes the device for errors when the device is
+ * known to be in an error state. A log will be created.
+ */
+ void onFailure() override;
+
+ /**
+ * Checks the device for errors and only creates a log
+ * if one is found.
+ */
+ void analyze() override;
+
+ /**
+ * Clears faults in the device
+ */
+ void clearFaults() override;
+
+ private:
+
+ /**
+ * Checks for VOUT faults on the device.
+ *
+ * This device can monitor voltages of its dependent
+ * devices, and VOUT faults are voltage faults
+ * on these devices.
+ *
+ * @return bool - true if an error log was created
+ */
+ bool checkVOUTFaults();
+
+ /**
+ * Checks for PGOOD faults on the device.
+ *
+ * This device can monitor the PGOOD signals of its dependent
+ * devices, and this check will look for faults of
+ * those PGOODs.
+ *
+ * @param[in] polling - If this is running while polling for errors,
+ * as opposing to analyzing a fail condition.
+ *
+ * @return bool - true if an error log was created
+ */
+ bool checkPGOODFaults(bool polling);
+
+ /**
+ * Creates an error log when the device has an error
+ * but it isn't a PGOOD or voltage failure.
+ */
+ void createPowerFaultLog();
+
+ /**
+ * The read/write interface to this hardware
+ */
+ pmbus::PMBus interface;
+
+ /**
+ * Keeps track of device access errors to avoid repeatedly
+ * logging errors for bad hardware
+ */
+ bool accessError = false;
+
+ /**
+ * Map of device instance to the instance specific data
+ */
+ static const ucd90160::DeviceMap deviceMap;
+};
+
+}
+}