1 #pragma once 2 3 #include "conf.hpp" 4 #include "controller.hpp" 5 #include "pidcontroller.hpp" 6 #include "sensors/manager.hpp" 7 #include "sensors/sensor.hpp" 8 #include "tuning.hpp" 9 #include "zone_interface.hpp" 10 11 #include <sdbusplus/bus.hpp> 12 #include <sdbusplus/server.hpp> 13 #include <xyz/openbmc_project/Control/Mode/server.hpp> 14 #include <xyz/openbmc_project/Object/Enable/server.hpp> 15 16 #include <fstream> 17 #include <iostream> 18 #include <map> 19 #include <memory> 20 #include <set> 21 #include <string> 22 #include <vector> 23 24 template <typename... T> 25 using ServerObject = typename sdbusplus::server::object_t<T...>; 26 using ModeInterface = sdbusplus::xyz::openbmc_project::Control::server::Mode; 27 using ModeObject = ServerObject<ModeInterface>; 28 using ProcessInterface = 29 sdbusplus::xyz::openbmc_project::Object::server::Enable; 30 using ProcessObject = ServerObject<ProcessInterface>; 31 32 namespace pid_control 33 { 34 35 /* 36 * The DbusPidZone inherits from the Mode object so that it can listen for 37 * control mode changes. It primarily holds all PID loops and holds the sensor 38 * value cache that's used per iteration of the PID loops. 39 */ 40 class DbusPidZone : public ZoneInterface, public ModeObject 41 { 42 public: 43 DbusPidZone(int64_t zone, double minThermalOutput, double failSafePercent, 44 conf::CycleTime cycleTime, const SensorManager& mgr, 45 sdbusplus::bus_t& bus, const char* objPath, bool defer) : 46 ModeObject(bus, objPath, 47 defer ? ModeObject::action::defer_emit 48 : ModeObject::action::emit_object_added), 49 _zoneId(zone), _maximumSetPoint(), 50 _minThermalOutputSetPt(minThermalOutput), 51 _failSafePercent(failSafePercent), _cycleTime(cycleTime), _mgr(mgr) 52 { 53 if (loggingEnabled) 54 { 55 _log.open(loggingPath + "/zone_" + std::to_string(zone) + ".log"); 56 } 57 } 58 59 bool getManualMode(void) const override; 60 /* Could put lock around this since it's accessed from two threads, but 61 * only one reader/one writer. 62 */ 63 64 bool getRedundantWrite(void) const override; 65 void setManualMode(bool mode); 66 bool getFailSafeMode(void) const override; 67 68 int64_t getZoneID(void) const override; 69 void addSetPoint(double setPoint, const std::string& name) override; 70 double getMaxSetPointRequest(void) const override; 71 void addRPMCeiling(double ceiling) override; 72 void clearSetPoints(void) override; 73 void clearRPMCeilings(void) override; 74 double getFailSafePercent(void) const override; 75 double getMinThermalSetPoint(void) const; 76 uint64_t getCycleIntervalTime(void) const override; 77 uint64_t getUpdateThermalsCycle(void) const override; 78 79 Sensor* getSensor(const std::string& name) override; 80 void determineMaxSetPointRequest(void) override; 81 void updateFanTelemetry(void) override; 82 void updateSensors(void) override; 83 void initializeCache(void) override; 84 void setOutputCache(std::string_view, const ValueCacheEntry&) override; 85 void dumpCache(void); 86 87 void processFans(void) override; 88 void processThermals(void) override; 89 90 void addFanPID(std::unique_ptr<Controller> pid); 91 void addThermalPID(std::unique_ptr<Controller> pid); 92 double getCachedValue(const std::string& name) override; 93 ValueCacheEntry getCachedValues(const std::string& name) override; 94 95 void addFanInput(const std::string& fan); 96 void addThermalInput(const std::string& therm); 97 98 void initializeLog(void) override; 99 void writeLog(const std::string& value) override; 100 101 /* Method for setting the manual mode over dbus */ 102 bool manual(bool value) override; 103 /* Method for reading whether in fail-safe mode over dbus */ 104 bool failSafe() const override; 105 /* Method for control process for each loop at runtime */ 106 void addPidControlProcess(std::string name, sdbusplus::bus_t& bus, 107 std::string objPath, bool defer); 108 bool isPidProcessEnabled(std::string name); 109 110 private: 111 template <bool fanSensorLogging> 112 void processSensorInputs(const std::vector<std::string>& sensorInputs, 113 std::chrono::high_resolution_clock::time_point now) 114 { 115 for (const auto& sensorInput : sensorInputs) 116 { 117 auto sensor = _mgr.getSensor(sensorInput); 118 ReadReturn r = sensor->read(); 119 _cachedValuesByName[sensorInput] = {r.value, r.unscaled}; 120 int64_t timeout = sensor->getTimeout(); 121 std::chrono::high_resolution_clock::time_point then = r.updated; 122 123 auto duration = 124 std::chrono::duration_cast<std::chrono::seconds>(now - then) 125 .count(); 126 auto period = std::chrono::seconds(timeout).count(); 127 /* 128 * TODO(venture): We should check when these were last read. 129 * However, these are the fans, so if I'm not getting updated values 130 * for them... what should I do? 131 */ 132 if constexpr (fanSensorLogging) 133 { 134 if (loggingEnabled) 135 { 136 const auto& v = _cachedValuesByName[sensorInput]; 137 _log << "," << v.scaled << "," << v.unscaled; 138 const auto& p = _cachedFanOutputs[sensorInput]; 139 _log << "," << p.scaled << "," << p.unscaled; 140 } 141 } 142 143 if (debugEnabled) 144 { 145 std::cerr << sensorInput << " sensor reading: " << r.value 146 << "\n"; 147 } 148 149 // check if fan fail. 150 if (sensor->getFailed()) 151 { 152 _failSafeSensors.insert(sensorInput); 153 if (debugEnabled) 154 { 155 std::cerr << sensorInput << " sensor get failed\n"; 156 } 157 } 158 else if (timeout != 0 && duration >= period) 159 { 160 _failSafeSensors.insert(sensorInput); 161 if (debugEnabled) 162 { 163 std::cerr << sensorInput << " sensor timeout\n"; 164 } 165 } 166 else 167 { 168 // Check if it's in there: remove it. 169 auto kt = _failSafeSensors.find(sensorInput); 170 if (kt != _failSafeSensors.end()) 171 { 172 if (debugEnabled) 173 { 174 std::cerr << sensorInput 175 << " is erased from failsafe sensor set\n"; 176 } 177 _failSafeSensors.erase(kt); 178 } 179 } 180 } 181 } 182 183 std::ofstream _log; 184 185 const int64_t _zoneId; 186 double _maximumSetPoint = 0; 187 std::string _maximumSetPointName; 188 std::string _maximumSetPointNamePrev; 189 bool _manualMode = false; 190 bool _redundantWrite = false; 191 const double _minThermalOutputSetPt; 192 const double _failSafePercent; 193 const conf::CycleTime _cycleTime; 194 195 std::set<std::string> _failSafeSensors; 196 197 std::vector<double> _SetPoints; 198 std::vector<double> _RPMCeilings; 199 std::vector<std::string> _fanInputs; 200 std::vector<std::string> _thermalInputs; 201 std::map<std::string, ValueCacheEntry> _cachedValuesByName; 202 std::map<std::string, ValueCacheEntry> _cachedFanOutputs; 203 const SensorManager& _mgr; 204 205 std::vector<std::unique_ptr<Controller>> _fans; 206 std::vector<std::unique_ptr<Controller>> _thermals; 207 208 std::map<std::string, std::unique_ptr<ProcessObject>> _pidsControlProcess; 209 }; 210 211 } // namespace pid_control 212