blob: 5bd5e47f216529ab9d2303ff0d83839c33fc52fb [file] [log] [blame]
Jim Wright539b6082021-08-02 14:50:23 -05001#pragma once
2
Jim Wright22318a32021-08-27 15:56:09 -05003#include "power_interface.hpp"
Jim Wright7945dd22021-04-06 16:55:15 -05004#include "power_sequencer_monitor.hpp"
Jim Wright2d99bf72021-11-19 11:18:12 -06005#include "utility.hpp"
Jim Wright22318a32021-08-27 15:56:09 -05006
Jim Wright7a5dd992021-08-31 16:56:52 -05007#include <gpiod.hpp>
Jim Wright539b6082021-08-02 14:50:23 -05008#include <sdbusplus/bus.hpp>
Jim Wright2d99bf72021-11-19 11:18:12 -06009#include <sdbusplus/bus/match.hpp>
Jim Wright539b6082021-08-02 14:50:23 -050010#include <sdbusplus/message.hpp>
11#include <sdbusplus/server/object.hpp>
Jim Wright7a5dd992021-08-31 16:56:52 -050012#include <sdeventplus/clock.hpp>
Jim Wright539b6082021-08-02 14:50:23 -050013#include <sdeventplus/event.hpp>
14#include <sdeventplus/utility/timer.hpp>
15
16#include <chrono>
17
18namespace phosphor::power::sequencer
19{
20
Jim Wright22318a32021-08-27 15:56:09 -050021using PowerObject = sdbusplus::server::object::object<PowerInterface>;
22
Jim Wright539b6082021-08-02 14:50:23 -050023/**
24 * @class PowerControl
25 * This class implements GPIO control of power on / off, and monitoring of the
26 * chassis power good.
27 */
Jim Wright22318a32021-08-27 15:56:09 -050028class PowerControl : public PowerObject
Jim Wright539b6082021-08-02 14:50:23 -050029{
30 public:
31 PowerControl() = delete;
32 PowerControl(const PowerControl&) = delete;
33 PowerControl& operator=(const PowerControl&) = delete;
34 PowerControl(PowerControl&&) = delete;
35 PowerControl& operator=(PowerControl&&) = delete;
36 ~PowerControl() = default;
37
38 /**
39 * Creates a controller object for power on and off.
40 * @param[in] bus D-Bus bus object
41 * @param[in] event event object
42 */
43 PowerControl(sdbusplus::bus::bus& bus, const sdeventplus::Event& event);
44
Jim Wright22318a32021-08-27 15:56:09 -050045 /** @copydoc PowerInterface::getPgood() */
46 int getPgood() const override;
47
48 /** @copydoc PowerInterface::getPgoodTimeout() */
49 int getPgoodTimeout() const override;
50
51 /** @copydoc PowerInterface::getState() */
52 int getState() const override;
53
Jim Wright2d99bf72021-11-19 11:18:12 -060054 /**
55 * Callback function to handle interfacesAdded D-Bus signals
56 * @param msg Expanded sdbusplus message data
57 */
58 void interfacesAddedHandler(sdbusplus::message::message& msg);
59
Jim Wright22318a32021-08-27 15:56:09 -050060 /** @copydoc PowerInterface::setPgoodTimeout() */
61 void setPgoodTimeout(int timeout) override;
62
63 /** @copydoc PowerInterface::setState() */
64 void setState(int state) override;
65
Jim Wrightccea2d22021-12-10 14:10:46 -060066 /** @copydoc PowerInterface::setPowerSupplyError() */
67 void setPowerSupplyError(const std::string& error) override;
68
Jim Wright539b6082021-08-02 14:50:23 -050069 private:
70 /**
71 * The D-Bus bus object
72 */
73 sdbusplus::bus::bus& bus;
74
75 /**
Jim Wright7945dd22021-04-06 16:55:15 -050076 * The power sequencer device to monitor.
77 */
Jim Wright930458c2022-01-24 14:37:27 -060078 std::unique_ptr<PowerSequencerMonitor> device;
Jim Wrightccea2d22021-12-10 14:10:46 -060079
80 /**
81 * Indicates if a specific power sequencer device has already been found.
82 */
83 bool deviceFound{false};
Jim Wright7945dd22021-04-06 16:55:15 -050084
85 /**
Jim Wright7a5dd992021-08-31 16:56:52 -050086 * Indicates if a state transistion is taking place
87 */
88 bool inStateTransition{false};
89
90 /**
Jim Wright2d99bf72021-11-19 11:18:12 -060091 * The match to Entity Manager interfaces added.
92 */
Jim Wrightccea2d22021-12-10 14:10:46 -060093 sdbusplus::bus::match_t match;
Jim Wright2d99bf72021-11-19 11:18:12 -060094
95 /**
Jim Wright22318a32021-08-27 15:56:09 -050096 * Power good
Jim Wright539b6082021-08-02 14:50:23 -050097 */
Jim Wright22318a32021-08-27 15:56:09 -050098 int pgood{0};
99
100 /**
Jim Wright7a5dd992021-08-31 16:56:52 -0500101 * GPIO line object for chassis power good
102 */
103 gpiod::line pgoodLine;
104
105 /**
Jim Wright22318a32021-08-27 15:56:09 -0500106 * Power good timeout constant
107 */
108 static constexpr std::chrono::seconds pgoodTimeout{
109 std::chrono::seconds(10)};
110
111 /**
Jim Wright7a5dd992021-08-31 16:56:52 -0500112 * Point in time at which power good timeout will take place
113 */
114 std::chrono::time_point<std::chrono::steady_clock> pgoodTimeoutTime;
115
116 /**
Jim Wright22318a32021-08-27 15:56:09 -0500117 * Poll interval constant
118 */
119 static constexpr std::chrono::milliseconds pollInterval{
120 std::chrono::milliseconds(3000)};
121
122 /**
Jim Wright7a5dd992021-08-31 16:56:52 -0500123 * GPIO line object for power-on / power-off control
124 */
125 gpiod::line powerControlLine;
126
127 /**
Jim Wrightccea2d22021-12-10 14:10:46 -0600128 * Power supply error
129 */
130 std::string powerSupplyError;
131
132 /**
Jim Wright22318a32021-08-27 15:56:09 -0500133 * Power state
134 */
135 int state{0};
136
137 /**
138 * Power good timeout
139 */
140 std::chrono::seconds timeout{pgoodTimeout};
Jim Wright539b6082021-08-02 14:50:23 -0500141
142 /**
143 * Timer to poll the pgood
144 */
145 sdeventplus::utility::Timer<sdeventplus::ClockId::Monotonic> timer;
146
147 /**
Jim Wright2d99bf72021-11-19 11:18:12 -0600148 * Get the device properties
149 * @param[in] properties A map of property names and values
150 */
151 void getDeviceProperties(util::DbusPropertyMap& properties);
152
153 /**
Jim Wright539b6082021-08-02 14:50:23 -0500154 * Polling method for monitoring the system power good
155 */
156 void pollPgood();
Jim Wright7a5dd992021-08-31 16:56:52 -0500157
158 /**
Jim Wright2d99bf72021-11-19 11:18:12 -0600159 * Set up power sequencer device
160 */
161 void setUpDevice();
162
163 /**
Jim Wright7a5dd992021-08-31 16:56:52 -0500164 * Set up GPIOs
165 */
166 void setUpGpio();
Jim Wright539b6082021-08-02 14:50:23 -0500167};
168
169} // namespace phosphor::power::sequencer