Vishwanatha Subbanna | 2180b2d | 2017-06-28 14:05:57 +0530 | [diff] [blame] | 1 | #pragma once |
| 2 | |
Vishwanatha Subbanna | 2180b2d | 2017-06-28 14:05:57 +0530 | [diff] [blame] | 3 | #include "occ_pass_through.hpp" |
Vishwanatha Subbanna | 307d80b | 2017-06-28 15:56:09 +0530 | [diff] [blame] | 4 | #include "occ_status.hpp" |
Tom Joseph | 815f9f5 | 2020-07-27 12:12:13 +0530 | [diff] [blame] | 5 | #ifdef PLDM |
| 6 | #include "pldm.hpp" |
| 7 | #endif |
Vishwanatha Subbanna | dfc7ec7 | 2017-09-07 18:18:01 +0530 | [diff] [blame] | 8 | #include "powercap.hpp" |
George Liu | f3b7514 | 2021-06-10 11:22:50 +0800 | [diff] [blame] | 9 | #include "utils.hpp" |
Chris Cain | 78e8601 | 2021-03-04 16:15:31 -0600 | [diff] [blame] | 10 | #ifdef POWER10 |
| 11 | #include "powermode.hpp" |
| 12 | #endif |
Vishwanatha Subbanna | 2180b2d | 2017-06-28 14:05:57 +0530 | [diff] [blame] | 13 | |
Gunnar Mills | 94df8c9 | 2018-09-14 14:50:03 -0500 | [diff] [blame] | 14 | #include <cstring> |
| 15 | #include <functional> |
| 16 | #include <sdbusplus/bus.hpp> |
Chris Cain | a8857c5 | 2021-01-27 11:53:05 -0600 | [diff] [blame] | 17 | #include <sdeventplus/event.hpp> |
| 18 | #include <sdeventplus/utility/timer.hpp> |
Gunnar Mills | 94df8c9 | 2018-09-14 14:50:03 -0500 | [diff] [blame] | 19 | #include <vector> |
| 20 | |
Vishwanatha Subbanna | 2180b2d | 2017-06-28 14:05:57 +0530 | [diff] [blame] | 21 | namespace sdbusRule = sdbusplus::bus::match::rules; |
Vishwanatha Subbanna | 2180b2d | 2017-06-28 14:05:57 +0530 | [diff] [blame] | 22 | namespace open_power |
| 23 | { |
| 24 | namespace occ |
| 25 | { |
| 26 | |
Chicago Duan | bb895cb | 2021-06-18 19:37:16 +0800 | [diff] [blame] | 27 | #ifdef READ_OCC_SENSORS |
| 28 | enum occFruType |
| 29 | { |
| 30 | processorCore = 0, |
| 31 | internalMemCtlr = 1, |
| 32 | dimm = 2, |
| 33 | memCtrlAndDimm = 3, |
| 34 | VRMVdd = 6, |
| 35 | PMIC = 7, |
| 36 | memCtlrExSensor = 8 |
| 37 | }; |
| 38 | #endif |
| 39 | |
Chris Cain | a8857c5 | 2021-01-27 11:53:05 -0600 | [diff] [blame] | 40 | /** @brief Default time, in seconds, between OCC poll commands */ |
Chicago Duan | bb895cb | 2021-06-18 19:37:16 +0800 | [diff] [blame] | 41 | constexpr unsigned int defaultPollingInterval = 1; |
Chris Cain | a8857c5 | 2021-01-27 11:53:05 -0600 | [diff] [blame] | 42 | |
Vishwanatha Subbanna | 2180b2d | 2017-06-28 14:05:57 +0530 | [diff] [blame] | 43 | /** @class Manager |
| 44 | * @brief Builds and manages OCC objects |
| 45 | */ |
| 46 | struct Manager |
| 47 | { |
Gunnar Mills | 94df8c9 | 2018-09-14 14:50:03 -0500 | [diff] [blame] | 48 | public: |
| 49 | Manager() = delete; |
| 50 | Manager(const Manager&) = delete; |
| 51 | Manager& operator=(const Manager&) = delete; |
| 52 | Manager(Manager&&) = delete; |
| 53 | Manager& operator=(Manager&&) = delete; |
| 54 | ~Manager() = default; |
Vishwanatha Subbanna | 2180b2d | 2017-06-28 14:05:57 +0530 | [diff] [blame] | 55 | |
Gunnar Mills | 94df8c9 | 2018-09-14 14:50:03 -0500 | [diff] [blame] | 56 | /** @brief Adds OCC pass-through and status objects on the bus |
| 57 | * when corresponding CPU inventory is created. |
| 58 | * |
Gunnar Mills | 94df8c9 | 2018-09-14 14:50:03 -0500 | [diff] [blame] | 59 | * @param[in] event - Unique ptr reference to sd_event |
| 60 | */ |
George Liu | f3b7514 | 2021-06-10 11:22:50 +0800 | [diff] [blame] | 61 | Manager(EventPtr& event) : |
| 62 | event(event), pollInterval(defaultPollingInterval), |
Chris Cain | a8857c5 | 2021-01-27 11:53:05 -0600 | [diff] [blame] | 63 | sdpEvent(sdeventplus::Event::get_default()), |
| 64 | _pollTimer( |
| 65 | std::make_unique< |
| 66 | sdeventplus::utility::Timer<sdeventplus::ClockId::Monotonic>>( |
| 67 | sdpEvent, std::bind(&Manager::pollerTimerExpired, this))) |
Tom Joseph | 815f9f5 | 2020-07-27 12:12:13 +0530 | [diff] [blame] | 68 | #ifdef PLDM |
| 69 | , |
| 70 | pldmHandle(std::make_unique<pldm::Interface>( |
George Liu | f3b7514 | 2021-06-10 11:22:50 +0800 | [diff] [blame] | 71 | std::bind(std::mem_fn(&Manager::updateOCCActive), this, |
| 72 | std::placeholders::_1, std::placeholders::_2))) |
Tom Joseph | 815f9f5 | 2020-07-27 12:12:13 +0530 | [diff] [blame] | 73 | #endif |
Matt Spinler | d267cec | 2021-09-01 14:49:19 -0500 | [diff] [blame^] | 74 | #ifdef POWER10 |
| 75 | , |
| 76 | discoverTimer( |
| 77 | std::make_unique< |
| 78 | sdeventplus::utility::Timer<sdeventplus::ClockId::Monotonic>>( |
| 79 | sdpEvent, std::bind(&Manager::findAndCreateObjects, this))) |
| 80 | #endif |
Gunnar Mills | 94df8c9 | 2018-09-14 14:50:03 -0500 | [diff] [blame] | 81 | { |
Lei YU | 0ab90ca | 2017-07-13 17:02:23 +0800 | [diff] [blame] | 82 | #ifdef I2C_OCC |
Gunnar Mills | 94df8c9 | 2018-09-14 14:50:03 -0500 | [diff] [blame] | 83 | // I2C OCC status objects are initialized directly |
| 84 | initStatusObjects(); |
Lei YU | 0ab90ca | 2017-07-13 17:02:23 +0800 | [diff] [blame] | 85 | #else |
Gunnar Mills | 94df8c9 | 2018-09-14 14:50:03 -0500 | [diff] [blame] | 86 | findAndCreateObjects(); |
Lei YU | 0ab90ca | 2017-07-13 17:02:23 +0800 | [diff] [blame] | 87 | #endif |
Gunnar Mills | 94df8c9 | 2018-09-14 14:50:03 -0500 | [diff] [blame] | 88 | } |
Vishwanatha Subbanna | 2180b2d | 2017-06-28 14:05:57 +0530 | [diff] [blame] | 89 | |
Chris Cain | a8857c5 | 2021-01-27 11:53:05 -0600 | [diff] [blame] | 90 | /** @brief Return the number of bound OCCs */ |
Gunnar Mills | 94df8c9 | 2018-09-14 14:50:03 -0500 | [diff] [blame] | 91 | inline auto getNumOCCs() const |
| 92 | { |
| 93 | return activeCount; |
| 94 | } |
Edward A. James | 636577f | 2017-10-06 10:53:55 -0500 | [diff] [blame] | 95 | |
Gunnar Mills | 94df8c9 | 2018-09-14 14:50:03 -0500 | [diff] [blame] | 96 | private: |
Matt Spinler | d267cec | 2021-09-01 14:49:19 -0500 | [diff] [blame^] | 97 | /** @brief Creates the OCC D-Bus objects. |
Gunnar Mills | 94df8c9 | 2018-09-14 14:50:03 -0500 | [diff] [blame] | 98 | */ |
| 99 | void findAndCreateObjects(); |
Vishwanatha Subbanna | dfc7ec7 | 2017-09-07 18:18:01 +0530 | [diff] [blame] | 100 | |
Gunnar Mills | 94df8c9 | 2018-09-14 14:50:03 -0500 | [diff] [blame] | 101 | /** @brief Callback that responds to cpu creation in the inventory - |
| 102 | * by creating the needed objects. |
| 103 | * |
| 104 | * @param[in] msg - bus message |
| 105 | * |
| 106 | * @returns 0 to indicate success |
| 107 | */ |
| 108 | int cpuCreated(sdbusplus::message::message& msg); |
Deepak Kodihalli | 5f031f3 | 2017-07-26 08:25:59 -0500 | [diff] [blame] | 109 | |
Gunnar Mills | 94df8c9 | 2018-09-14 14:50:03 -0500 | [diff] [blame] | 110 | /** @brief Create child OCC objects. |
| 111 | * |
| 112 | * @param[in] occ - the occ name, such as occ0. |
| 113 | */ |
| 114 | void createObjects(const std::string& occ); |
Vishwanatha Subbanna | 2180b2d | 2017-06-28 14:05:57 +0530 | [diff] [blame] | 115 | |
Gunnar Mills | 94df8c9 | 2018-09-14 14:50:03 -0500 | [diff] [blame] | 116 | /** @brief Callback handler invoked by Status object when the OccActive |
| 117 | * property is changed. This is needed to make sure that the |
| 118 | * error detection is started only after all the OCCs are bound. |
| 119 | * Similarly, when one of the OCC gets its OccActive property |
| 120 | * un-set, then the OCC error detection needs to be stopped on |
| 121 | * all the OCCs |
| 122 | * |
| 123 | * @param[in] status - OccActive status |
| 124 | */ |
| 125 | void statusCallBack(bool status); |
Vishwanatha Subbanna | 2dc9b1a | 2017-08-18 18:29:41 +0530 | [diff] [blame] | 126 | |
Gunnar Mills | 94df8c9 | 2018-09-14 14:50:03 -0500 | [diff] [blame] | 127 | /** @brief Sends a Heartbeat command to host control command handler */ |
| 128 | void sendHeartBeat(); |
Vishwanatha Subbanna | 2dc9b1a | 2017-08-18 18:29:41 +0530 | [diff] [blame] | 129 | |
Gunnar Mills | 94df8c9 | 2018-09-14 14:50:03 -0500 | [diff] [blame] | 130 | /** @brief reference to sd_event wrapped in unique_ptr */ |
| 131 | EventPtr& event; |
Vishwanatha Subbanna | ee4d83d | 2017-06-29 18:35:00 +0530 | [diff] [blame] | 132 | |
Gunnar Mills | 94df8c9 | 2018-09-14 14:50:03 -0500 | [diff] [blame] | 133 | /** @brief OCC pass-through objects */ |
| 134 | std::vector<std::unique_ptr<PassThrough>> passThroughObjects; |
Vishwanatha Subbanna | 307d80b | 2017-06-28 15:56:09 +0530 | [diff] [blame] | 135 | |
Gunnar Mills | 94df8c9 | 2018-09-14 14:50:03 -0500 | [diff] [blame] | 136 | /** @brief OCC Status objects */ |
| 137 | std::vector<std::unique_ptr<Status>> statusObjects; |
Vishwanatha Subbanna | 2180b2d | 2017-06-28 14:05:57 +0530 | [diff] [blame] | 138 | |
Gunnar Mills | 94df8c9 | 2018-09-14 14:50:03 -0500 | [diff] [blame] | 139 | /** @brief Power cap monitor and occ notification object */ |
| 140 | std::unique_ptr<open_power::occ::powercap::PowerCap> pcap; |
Andrew Geissler | 52cf26a | 2017-07-06 12:56:32 -0500 | [diff] [blame] | 141 | |
Chris Cain | 78e8601 | 2021-03-04 16:15:31 -0600 | [diff] [blame] | 142 | #ifdef POWER10 |
| 143 | /** @brief Power mode monitor and notification object */ |
| 144 | std::unique_ptr<open_power::occ::powermode::PowerMode> pmode; |
| 145 | #endif |
| 146 | |
Gunnar Mills | 94df8c9 | 2018-09-14 14:50:03 -0500 | [diff] [blame] | 147 | /** @brief sbdbusplus match objects */ |
| 148 | std::vector<sdbusplus::bus::match_t> cpuMatches; |
Vishwanatha Subbanna | 2dc9b1a | 2017-08-18 18:29:41 +0530 | [diff] [blame] | 149 | |
Gunnar Mills | 94df8c9 | 2018-09-14 14:50:03 -0500 | [diff] [blame] | 150 | /** @brief Number of OCCs that are bound */ |
| 151 | uint8_t activeCount = 0; |
Lei YU | 0ab90ca | 2017-07-13 17:02:23 +0800 | [diff] [blame] | 152 | |
Chris Cain | a8857c5 | 2021-01-27 11:53:05 -0600 | [diff] [blame] | 153 | /** @brief Number of seconds between poll commands */ |
| 154 | uint8_t pollInterval; |
| 155 | |
| 156 | /** @brief Poll timer event */ |
| 157 | sdeventplus::Event sdpEvent; |
| 158 | |
| 159 | /** |
| 160 | * @brief The timer to be used once the OCC goes active. When it expires, |
| 161 | * a POLL command will be sent to the OCC and then timer restarted. |
| 162 | */ |
| 163 | std::unique_ptr< |
| 164 | sdeventplus::utility::Timer<sdeventplus::ClockId::Monotonic>> |
| 165 | _pollTimer; |
| 166 | |
Lei YU | 0ab90ca | 2017-07-13 17:02:23 +0800 | [diff] [blame] | 167 | #ifdef I2C_OCC |
Gunnar Mills | 94df8c9 | 2018-09-14 14:50:03 -0500 | [diff] [blame] | 168 | /** @brief Init Status objects for I2C OCC devices |
| 169 | * |
| 170 | * It iterates in /sys/bus/i2c/devices, finds all occ hwmon devices |
| 171 | * and creates status objects. |
| 172 | */ |
| 173 | void initStatusObjects(); |
Lei YU | 0ab90ca | 2017-07-13 17:02:23 +0800 | [diff] [blame] | 174 | #endif |
Tom Joseph | 815f9f5 | 2020-07-27 12:12:13 +0530 | [diff] [blame] | 175 | |
| 176 | #ifdef PLDM |
| 177 | /** @brief Callback handler invoked by the PLDM event handler when state of |
| 178 | * the OCC is toggled by the host. The caller passes the instance |
| 179 | * of the OCC and state of the OCC. |
| 180 | * |
| 181 | * @param[in] instance - instance of the OCC |
| 182 | * @param[in] status - true when the OCC goes active and false when the OCC |
| 183 | * goes inactive |
| 184 | * |
| 185 | * @return true if setting the state of OCC is successful and false if it |
| 186 | * fails. |
| 187 | */ |
| 188 | bool updateOCCActive(instanceID instance, bool status); |
| 189 | |
| 190 | std::unique_ptr<pldm::Interface> pldmHandle = nullptr; |
| 191 | #endif |
Chris Cain | a8857c5 | 2021-01-27 11:53:05 -0600 | [diff] [blame] | 192 | |
Matt Spinler | d267cec | 2021-09-01 14:49:19 -0500 | [diff] [blame^] | 193 | #ifdef POWER10 |
| 194 | /** |
| 195 | * @brief Timer used when discovering OCCs in /dev. |
| 196 | */ |
| 197 | std::unique_ptr< |
| 198 | sdeventplus::utility::Timer<sdeventplus::ClockId::Monotonic>> |
| 199 | discoverTimer; |
| 200 | |
| 201 | /** |
| 202 | * @brief Used when discovering /dev/occ objects to know if |
| 203 | * any were added since the last check. |
| 204 | */ |
| 205 | std::vector<int> prevOCCSearch; |
| 206 | #endif |
| 207 | |
Chris Cain | a8857c5 | 2021-01-27 11:53:05 -0600 | [diff] [blame] | 208 | /** |
| 209 | * @brief Called when poll timer expires and forces a POLL command to the |
| 210 | * OCC. The poll timer will then be restarted. |
| 211 | * */ |
| 212 | void pollerTimerExpired(); |
Chicago Duan | bb895cb | 2021-06-18 19:37:16 +0800 | [diff] [blame] | 213 | |
Matt Spinler | d267cec | 2021-09-01 14:49:19 -0500 | [diff] [blame^] | 214 | /** |
| 215 | * @brief Finds the OCC devices in /dev |
| 216 | * |
| 217 | * @return The IDs of the OCCs - 0, 1, etc. |
| 218 | */ |
| 219 | std::vector<int> findOCCsInDev(); |
| 220 | |
Chicago Duan | bb895cb | 2021-06-18 19:37:16 +0800 | [diff] [blame] | 221 | #ifdef READ_OCC_SENSORS |
| 222 | /** |
| 223 | * @brief Gets the occ sensor values. |
| 224 | * @param[in] id - Id of the OCC. |
| 225 | * @param[in] masterOcc - Is this OCC the master OCC. |
| 226 | * */ |
| 227 | void getSensorValues(uint32_t id, bool masterOcc); |
| 228 | |
| 229 | /** |
| 230 | * @brief Trigger OCC driver to read the temperature sensors. |
| 231 | * @param[in] path - path of the OCC sensors. |
| 232 | * @param[in] id - Id of the OCC. |
| 233 | * */ |
| 234 | void readTempSensors(const fs::path& path, uint32_t id); |
| 235 | |
| 236 | /** |
| 237 | * @brief Trigger OCC driver to read the power sensors. |
| 238 | * @param[in] path - path of the OCC sensors. |
| 239 | * @param[in] id - Id of the OCC. |
| 240 | * */ |
| 241 | void readPowerSensors(const fs::path& path, uint32_t id); |
| 242 | |
| 243 | /** |
| 244 | * @brief Set all sensor values of this OCC to NaN. |
| 245 | * @param[in] id - Id of the OCC. |
| 246 | * */ |
| 247 | void setSensorValueToNaN(uint32_t id); |
| 248 | |
| 249 | /** @brief Store the existing OCC sensors on D-BUS */ |
| 250 | std::map<std::string, uint32_t> existingSensors; |
| 251 | |
| 252 | /** @brief Get FunctionID from the `powerX_label` file. |
| 253 | * @param[in] value - the value of the `powerX_label` file. |
| 254 | * @returns FunctionID of the power sensors. |
| 255 | */ |
| 256 | std::optional<std::string> |
| 257 | getPowerLabelFunctionID(const std::string& value); |
| 258 | |
| 259 | /** @brief The power sensor names map */ |
| 260 | const std::map<std::string, std::string> powerSensorName = { |
| 261 | {"system", "total_power"}, {"1", "p0_mem_power"}, |
| 262 | {"2", "p1_mem_power"}, {"3", "p2_mem_power"}, |
| 263 | {"4", "p3_mem_power"}, {"5", "p0_power"}, |
| 264 | {"6", "p1_power"}, {"7", "p2_power"}, |
| 265 | {"8", "p3_power"}, {"9", "p0_cache_power"}, |
| 266 | {"10", "p1_cache_power"}, {"11", "p2_cache_power"}, |
| 267 | {"12", "p3_cache_power"}, {"13", "io_a_power"}, |
| 268 | {"14", "io_b_power"}, {"15", "io_c_power"}, |
| 269 | {"16", "fans_a_power"}, {"17", "fans_b_power"}, |
| 270 | {"18", "storage_a_power"}, {"19", "storage_b_power"}, |
| 271 | {"23", "mem_cache_power"}, {"25", "p0_mem_0_power"}, |
| 272 | {"26", "p0_mem_1_power"}, {"27", "p0_mem_2_power"}}; |
| 273 | |
| 274 | /** @brief The dimm temperature sensor names map */ |
| 275 | const std::map<uint32_t, std::string> dimmTempSensorName = { |
| 276 | {internalMemCtlr, "_intmb_temp"}, |
| 277 | {dimm, "_dram_temp"}, |
| 278 | {memCtrlAndDimm, "_dram_extmb_temp"}, |
| 279 | {PMIC, "_pmic_temp"}, |
| 280 | {memCtlrExSensor, "_extmb_temp"}}; |
| 281 | #endif |
Vishwanatha Subbanna | 2180b2d | 2017-06-28 14:05:57 +0530 | [diff] [blame] | 282 | }; |
| 283 | |
| 284 | } // namespace occ |
| 285 | } // namespace open_power |