blob: eb310da48b4e01b6182773bd5d19406b99be8d09 [file] [log] [blame]
Brandon Wymana0f33ce2019-10-17 18:32:29 -05001#pragma once
2
Brandon Wyman8d195772020-01-27 15:03:51 -06003#include "pmbus.hpp"
Brandon Wymanaed1f752019-11-25 18:10:52 -06004#include "types.hpp"
Brandon Wyman3f1242f2020-01-28 13:11:25 -06005#include "utility.hpp"
Brandon Wymanaed1f752019-11-25 18:10:52 -06006
7#include <sdbusplus/bus/match.hpp>
8
Brandon Wyman1d7a7df2020-03-26 10:14:05 -05009#include <stdexcept>
10
Brandon Wymana0f33ce2019-10-17 18:32:29 -050011namespace phosphor::power::psu
12{
Brandon Wyman3f1242f2020-01-28 13:11:25 -060013
Brandon Wyman1d7a7df2020-03-26 10:14:05 -050014#ifdef IBM_VPD
15// PMBus device driver "file name" to read for CCIN value.
16constexpr auto CCIN = "ccin";
17constexpr auto PART_NUMBER = "part_number";
18constexpr auto FRU_NUMBER = "fru";
19constexpr auto SERIAL_HEADER = "header";
20constexpr auto SERIAL_NUMBER = "serial_number";
21constexpr auto FW_VERSION = "fw_version";
22
23// The D-Bus property name to update with the CCIN value.
24constexpr auto MODEL_PROP = "Model";
25constexpr auto PN_PROP = "PartNumber";
26constexpr auto SN_PROP = "SerialNumber";
27constexpr auto VERSION_PROP = "Version";
28
29// ipzVPD Keyword sizes
30static constexpr auto FL_KW_SIZE = 20;
31#endif
32
Brandon Wymana0f33ce2019-10-17 18:32:29 -050033/**
34 * @class PowerSupply
35 * Represents a PMBus power supply device.
36 */
37class PowerSupply
38{
39 public:
Brandon Wymanaed1f752019-11-25 18:10:52 -060040 PowerSupply() = delete;
Brandon Wymana0f33ce2019-10-17 18:32:29 -050041 PowerSupply(const PowerSupply&) = delete;
42 PowerSupply(PowerSupply&&) = delete;
43 PowerSupply& operator=(const PowerSupply&) = delete;
44 PowerSupply& operator=(PowerSupply&&) = delete;
45 ~PowerSupply() = default;
46
47 /**
Brandon Wymanc63941c2020-01-27 16:49:33 -060048 * @param[in] invpath - String for inventory path to use
49 * @param[in] i2cbus - The bus number this power supply is on
50 * @param[in] i2caddr - The 16-bit I2C address of the power supply
Brandon Wymanaed1f752019-11-25 18:10:52 -060051 */
Brandon Wymanc63941c2020-01-27 16:49:33 -060052 PowerSupply(sdbusplus::bus::bus& bus, const std::string& invpath,
53 std::uint8_t i2cbus, const std::string& i2caddr) :
54 bus(bus),
Brandon Wyman8d195772020-01-27 15:03:51 -060055 inventoryPath(invpath),
56 pmbusIntf(phosphor::pmbus::createPMBus(i2cbus, i2caddr))
Brandon Wymanaed1f752019-11-25 18:10:52 -060057 {
Brandon Wyman1d7a7df2020-03-26 10:14:05 -050058 if (inventoryPath.empty())
59 {
60 throw std::invalid_argument{"Invalid empty inventoryPath"};
61 }
62
Brandon Wymanaed1f752019-11-25 18:10:52 -060063 // Setup the functions to call when the D-Bus inventory path for the
64 // Present property changes.
65 presentMatch = std::make_unique<sdbusplus::bus::match_t>(
66 bus,
67 sdbusplus::bus::match::rules::propertiesChanged(inventoryPath,
68 INVENTORY_IFACE),
69 [this](auto& msg) { this->inventoryChanged(msg); });
70 presentAddedMatch = std::make_unique<sdbusplus::bus::match_t>(
71 bus,
72 sdbusplus::bus::match::rules::interfacesAdded() +
73 sdbusplus::bus::match::rules::path_namespace(inventoryPath),
74 [this](auto& msg) { this->inventoryChanged(msg); });
75 // Get the current state of the Present property.
76 updatePresence();
77 }
78
Brandon Wyman3f1242f2020-01-28 13:11:25 -060079 phosphor::pmbus::PMBusBase& getPMBus()
80 {
81 return *pmbusIntf;
82 }
83
Brandon Wymanaed1f752019-11-25 18:10:52 -060084 /**
Brandon Wymana0f33ce2019-10-17 18:32:29 -050085 * Power supply specific function to analyze for faults/errors.
86 *
87 * Various PMBus status bits will be checked for fault conditions.
88 * If a certain fault bits are on, the appropriate error will be
89 * committed.
90 */
Brandon Wyman3f1242f2020-01-28 13:11:25 -060091 void analyze();
Brandon Wymana0f33ce2019-10-17 18:32:29 -050092
93 /**
Brandon Wyman59a35792020-06-04 12:37:40 -050094 * Write PMBus ON_OFF_CONFIG
95 *
96 * This function will be called to cause the PMBus device driver to send the
97 * ON_OFF_CONFIG command. Takes one byte of data.
98 *
99 * @param[in] data - The ON_OFF_CONFIG data byte mask.
100 */
101 void onOffConfig(uint8_t data);
102
103 /**
Brandon Wymana0f33ce2019-10-17 18:32:29 -0500104 * Write PMBus CLEAR_FAULTS
105 *
106 * This function will be called in various situations in order to clear
107 * any fault status bits that may have been set, in order to start over
108 * with a clean state. Presence changes and power state changes will
109 * want to clear any faults logged.
110 */
Brandon Wyman3c208462020-05-13 16:25:58 -0500111 void clearFaults();
Brandon Wymana0f33ce2019-10-17 18:32:29 -0500112
113 /**
114 * @brief Adds properties to the inventory.
115 *
116 * Reads the values from the device and writes them to the
117 * associated power supply D-Bus inventory object.
118 *
119 * This needs to be done on startup, and each time the presence
120 * state changes.
121 *
122 * Properties added:
123 * - Serial Number
124 * - Part Number
125 * - CCIN (Customer Card Identification Number) - added as the Model
126 * - Firmware version
127 */
Brandon Wyman1d7a7df2020-03-26 10:14:05 -0500128 void updateInventory();
Brandon Wymana0f33ce2019-10-17 18:32:29 -0500129
Brandon Wymanaed1f752019-11-25 18:10:52 -0600130 /**
131 * @brief Accessor function to indicate present status
132 */
133 bool isPresent() const
134 {
135 return present;
136 }
137
Brandon Wyman3f1242f2020-01-28 13:11:25 -0600138 /**
139 * @brief Returns true if a fault was found.
140 */
141 bool isFaulted() const
142 {
143 return faultFound;
144 }
145
146 /**
147 * @brief Returns true if INPUT fault occurred.
148 */
149 bool hasInputFault() const
150 {
151 return inputFault;
152 }
153
154 /**
155 * @brief Returns true if MFRSPECIFIC occurred.
156 */
157 bool hasMFRFault() const
158 {
159 return mfrFault;
160 }
161
162 /**
163 * @brief Returns true if VIN_UV_FAULT occurred.
164 */
165 bool hasVINUVFault() const
166 {
167 return vinUVFault;
168 }
169
Brandon Wymana0f33ce2019-10-17 18:32:29 -0500170 private:
Brandon Wymanaed1f752019-11-25 18:10:52 -0600171 /** @brief systemd bus member */
172 sdbusplus::bus::bus& bus;
173
Brandon Wymana0f33ce2019-10-17 18:32:29 -0500174 /** @brief True if a fault has already been found and not cleared */
175 bool faultFound = false;
Brandon Wymanaed1f752019-11-25 18:10:52 -0600176
Brandon Wyman3f1242f2020-01-28 13:11:25 -0600177 /** @brief True if bit 5 of STATUS_WORD high byte is on. */
178 bool inputFault = false;
179
180 /** @brief True if bit 4 of STATUS_WORD high byte is on. */
181 bool mfrFault = false;
182
183 /** @brief True if bit 3 of STATUS_WORD low byte is on. */
184 bool vinUVFault = false;
185
Brandon Wymanaed1f752019-11-25 18:10:52 -0600186 /**
187 * @brief D-Bus path to use for this power supply's inventory status.
188 **/
189 std::string inventoryPath;
190
191 /** @brief True if the power supply is present. */
192 bool present = false;
193
194 /** @brief D-Bus match variable used to subscribe to Present property
195 * changes.
196 **/
197 std::unique_ptr<sdbusplus::bus::match_t> presentMatch;
198
199 /** @brief D-Bus match variable used to subscribe for Present property
200 * interface added.
201 */
202 std::unique_ptr<sdbusplus::bus::match_t> presentAddedMatch;
203
204 /**
Brandon Wyman8d195772020-01-27 15:03:51 -0600205 * @brief Pointer to the PMBus interface
206 *
207 * Used to read or write to/from PMBus power supply devices.
208 */
209 std::unique_ptr<phosphor::pmbus::PMBusBase> pmbusIntf;
210
211 /**
Brandon Wymanaed1f752019-11-25 18:10:52 -0600212 * @brief Updates the presence status by querying D-Bus
213 *
214 * The D-Bus inventory properties for this power supply will be read to
215 * determine if the power supply is present or not and update this
216 * object's present member variable to reflect current status.
217 **/
218 void updatePresence();
219
220 /**
221 * @brief Callback for inventory property changes
222 *
223 * Process change of Present property for power supply.
224 *
225 * @param[in] msg - Data associated with Present change signal
226 **/
227 void inventoryChanged(sdbusplus::message::message& msg);
Brandon Wymana0f33ce2019-10-17 18:32:29 -0500228};
229
230} // namespace phosphor::power::psu