| /* |
| // Copyright (c) 2019 Intel Corporation |
| // |
| // Licensed under the Apache License, Version 2.0 (the "License"); |
| // you may not use this file except in compliance with the License. |
| // You may obtain a copy of the License at |
| // |
| // http://www.apache.org/licenses/LICENSE-2.0 |
| // |
| // Unless required by applicable law or agreed to in writing, software |
| // distributed under the License is distributed on an "AS IS" BASIS, |
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| // See the License for the specific language governing permissions and |
| // limitations under the License. |
| */ |
| |
| #include <IpmbSensor.hpp> |
| #include <Utils.hpp> |
| #include <VariantVisitors.hpp> |
| #include <boost/algorithm/string/predicate.hpp> |
| #include <boost/container/flat_map.hpp> |
| #include <sdbusplus/asio/connection.hpp> |
| #include <sdbusplus/asio/object_server.hpp> |
| #include <sdbusplus/bus/match.hpp> |
| |
| #include <chrono> |
| #include <cmath> |
| #include <functional> |
| #include <iostream> |
| #include <limits> |
| #include <memory> |
| #include <numeric> |
| #include <string> |
| #include <tuple> |
| #include <variant> |
| #include <vector> |
| |
| constexpr const bool debug = false; |
| |
| constexpr const char* configInterface = |
| "xyz.openbmc_project.Configuration.IpmbSensor"; |
| static constexpr double ipmbMaxReading = 0xFF; |
| static constexpr double ipmbMinReading = 0; |
| |
| static constexpr uint8_t meAddress = 1; |
| static constexpr uint8_t lun = 0; |
| static constexpr uint8_t hostSMbusIndexDefault = 0x03; |
| static constexpr float pollRateDefault = 1; // in seconds |
| |
| static constexpr const char* sensorPathPrefix = "/xyz/openbmc_project/sensors/"; |
| |
| using IpmbMethodType = |
| std::tuple<int, uint8_t, uint8_t, uint8_t, uint8_t, std::vector<uint8_t>>; |
| |
| boost::container::flat_map<std::string, std::unique_ptr<IpmbSensor>> sensors; |
| |
| std::unique_ptr<boost::asio::deadline_timer> initCmdTimer; |
| |
| IpmbSensor::IpmbSensor(std::shared_ptr<sdbusplus::asio::connection>& conn, |
| boost::asio::io_service& io, |
| const std::string& sensorName, |
| const std::string& sensorConfiguration, |
| sdbusplus::asio::object_server& objectServer, |
| std::vector<thresholds::Threshold>&& thresholdData, |
| uint8_t deviceAddress, uint8_t hostSMbusIndex, |
| const float pollRate, std::string& sensorTypeName) : |
| Sensor(escapeName(sensorName), std::move(thresholdData), |
| sensorConfiguration, "xyz.openbmc_project.Configuration.ExitAirTemp", |
| false, false, ipmbMaxReading, ipmbMinReading, conn, PowerState::on), |
| deviceAddress(deviceAddress), hostSMbusIndex(hostSMbusIndex), |
| sensorPollMs(static_cast<int>(pollRate * 1000)), objectServer(objectServer), |
| waitTimer(io) |
| { |
| std::string dbusPath = sensorPathPrefix + sensorTypeName + "/" + name; |
| |
| sensorInterface = objectServer.add_interface( |
| dbusPath, "xyz.openbmc_project.Sensor.Value"); |
| |
| for (const auto& threshold : thresholds) |
| { |
| std::string interface = thresholds::getInterface(threshold.level); |
| thresholdInterfaces[static_cast<size_t>(threshold.level)] = |
| objectServer.add_interface(dbusPath, interface); |
| } |
| association = objectServer.add_interface(dbusPath, association::interface); |
| } |
| |
| IpmbSensor::~IpmbSensor() |
| { |
| waitTimer.cancel(); |
| for (const auto& iface : thresholdInterfaces) |
| { |
| objectServer.remove_interface(iface); |
| } |
| objectServer.remove_interface(sensorInterface); |
| objectServer.remove_interface(association); |
| } |
| |
| std::string IpmbSensor::getSubTypeUnits(void) const |
| { |
| switch (subType) |
| { |
| case IpmbSubType::temp: |
| return sensor_paths::unitDegreesC; |
| case IpmbSubType::curr: |
| return sensor_paths::unitAmperes; |
| case IpmbSubType::power: |
| return sensor_paths::unitWatts; |
| case IpmbSubType::volt: |
| return sensor_paths::unitVolts; |
| case IpmbSubType::util: |
| return sensor_paths::unitPercent; |
| default: |
| throw std::runtime_error("Invalid sensor type"); |
| } |
| } |
| |
| void IpmbSensor::init(void) |
| { |
| loadDefaults(); |
| setInitialProperties(getSubTypeUnits()); |
| if (initCommand) |
| { |
| runInitCmd(); |
| } |
| read(); |
| } |
| |
| void IpmbSensor::runInitCmd() |
| { |
| if (initCommand) |
| { |
| dbusConnection->async_method_call( |
| [this](boost::system::error_code ec, |
| const IpmbMethodType& response) { |
| const int& status = std::get<0>(response); |
| |
| if (ec || (status != 0)) |
| { |
| std::cerr << "Error setting init command for device: " << name |
| << "\n"; |
| } |
| }, |
| "xyz.openbmc_project.Ipmi.Channel.Ipmb", |
| "/xyz/openbmc_project/Ipmi/Channel/Ipmb", "org.openbmc.Ipmb", |
| "sendRequest", commandAddress, netfn, lun, *initCommand, initData); |
| } |
| } |
| |
| void IpmbSensor::loadDefaults() |
| { |
| if (type == IpmbType::meSensor) |
| { |
| commandAddress = meAddress; |
| netfn = ipmi::sensor::netFn; |
| command = ipmi::sensor::getSensorReading; |
| commandData = {deviceAddress}; |
| readingFormat = ReadingFormat::byte0; |
| } |
| else if (type == IpmbType::PXE1410CVR) |
| { |
| commandAddress = meAddress; |
| netfn = ipmi::me_bridge::netFn; |
| command = ipmi::me_bridge::sendRawPmbus; |
| initCommand = ipmi::me_bridge::sendRawPmbus; |
| // pmbus read temp |
| commandData = {0x57, 0x01, 0x00, 0x16, hostSMbusIndex, |
| deviceAddress, 0x00, 0x00, 0x00, 0x00, |
| 0x01, 0x02, 0x8d}; |
| // goto page 0 |
| initData = {0x57, 0x01, 0x00, 0x14, hostSMbusIndex, |
| deviceAddress, 0x00, 0x00, 0x00, 0x00, |
| 0x02, 0x00, 0x00, 0x00}; |
| readingFormat = ReadingFormat::linearElevenBit; |
| } |
| else if (type == IpmbType::IR38363VR) |
| { |
| commandAddress = meAddress; |
| netfn = ipmi::me_bridge::netFn; |
| command = ipmi::me_bridge::sendRawPmbus; |
| // pmbus read temp |
| commandData = {0x57, 0x01, 0x00, 0x16, hostSMbusIndex, |
| deviceAddress, 00, 0x00, 0x00, 0x00, |
| 0x01, 0x02, 0x8D}; |
| readingFormat = ReadingFormat::elevenBitShift; |
| } |
| else if (type == IpmbType::ADM1278HSC) |
| { |
| commandAddress = meAddress; |
| uint8_t snsNum = 0; |
| switch (subType) |
| { |
| case IpmbSubType::temp: |
| case IpmbSubType::curr: |
| if (subType == IpmbSubType::temp) |
| { |
| snsNum = 0x8d; |
| } |
| else |
| { |
| snsNum = 0x8c; |
| } |
| netfn = ipmi::me_bridge::netFn; |
| command = ipmi::me_bridge::sendRawPmbus; |
| commandData = {0x57, 0x01, 0x00, 0x86, deviceAddress, |
| 0x00, 0x00, 0x01, 0x02, snsNum}; |
| readingFormat = ReadingFormat::elevenBit; |
| break; |
| case IpmbSubType::power: |
| case IpmbSubType::volt: |
| netfn = ipmi::sensor::netFn; |
| command = ipmi::sensor::getSensorReading; |
| commandData = {deviceAddress}; |
| readingFormat = ReadingFormat::byte0; |
| break; |
| default: |
| throw std::runtime_error("Invalid sensor type"); |
| } |
| } |
| else if (type == IpmbType::mpsVR) |
| { |
| commandAddress = meAddress; |
| netfn = ipmi::me_bridge::netFn; |
| command = ipmi::me_bridge::sendRawPmbus; |
| initCommand = ipmi::me_bridge::sendRawPmbus; |
| // pmbus read temp |
| commandData = {0x57, 0x01, 0x00, 0x16, hostSMbusIndex, |
| deviceAddress, 0x00, 0x00, 0x00, 0x00, |
| 0x01, 0x02, 0x8d}; |
| // goto page 0 |
| initData = {0x57, 0x01, 0x00, 0x14, hostSMbusIndex, |
| deviceAddress, 0x00, 0x00, 0x00, 0x00, |
| 0x02, 0x00, 0x00, 0x00}; |
| readingFormat = ReadingFormat::byte3; |
| } |
| else |
| { |
| throw std::runtime_error("Invalid sensor type"); |
| } |
| |
| if (subType == IpmbSubType::util) |
| { |
| // Utilization need to be scaled to percent |
| maxValue = 100; |
| minValue = 0; |
| } |
| } |
| |
| void IpmbSensor::checkThresholds(void) |
| { |
| thresholds::checkThresholds(this); |
| } |
| |
| bool IpmbSensor::processReading(const std::vector<uint8_t>& data, double& resp) |
| { |
| |
| switch (readingFormat) |
| { |
| case (ReadingFormat::byte0): |
| { |
| if (command == ipmi::sensor::getSensorReading && |
| !ipmi::sensor::isValid(data)) |
| { |
| return false; |
| } |
| resp = data[0]; |
| return true; |
| } |
| case (ReadingFormat::byte3): |
| { |
| if (data.size() < 4) |
| { |
| if (errCount == 0U) |
| { |
| std::cerr << "Invalid data length returned for " << name |
| << "\n"; |
| } |
| return false; |
| } |
| resp = data[3]; |
| return true; |
| } |
| case (ReadingFormat::elevenBit): |
| { |
| if (data.size() < 5) |
| { |
| if (errCount == 0U) |
| { |
| std::cerr << "Invalid data length returned for " << name |
| << "\n"; |
| } |
| return false; |
| } |
| |
| int16_t value = ((data[4] << 8) | data[3]); |
| resp = value; |
| return true; |
| } |
| case (ReadingFormat::elevenBitShift): |
| { |
| if (data.size() < 5) |
| { |
| if (errCount == 0U) |
| { |
| std::cerr << "Invalid data length returned for " << name |
| << "\n"; |
| } |
| return false; |
| } |
| |
| resp = ((data[4] << 8) | data[3]) >> 3; |
| return true; |
| } |
| case (ReadingFormat::linearElevenBit): |
| { |
| if (data.size() < 5) |
| { |
| if (errCount == 0U) |
| { |
| std::cerr << "Invalid data length returned for " << name |
| << "\n"; |
| } |
| return false; |
| } |
| |
| int16_t value = ((data[4] << 8) | data[3]); |
| constexpr const size_t shift = 16 - 11; // 11bit into 16bit |
| value <<= shift; |
| value >>= shift; |
| resp = value; |
| return true; |
| } |
| default: |
| throw std::runtime_error("Invalid reading type"); |
| } |
| } |
| |
| void IpmbSensor::read(void) |
| { |
| waitTimer.expires_from_now(boost::posix_time::milliseconds(sensorPollMs)); |
| waitTimer.async_wait([this](const boost::system::error_code& ec) { |
| if (ec == boost::asio::error::operation_aborted) |
| { |
| return; // we're being canceled |
| } |
| if (!readingStateGood()) |
| { |
| updateValue(std::numeric_limits<double>::quiet_NaN()); |
| read(); |
| return; |
| } |
| dbusConnection->async_method_call( |
| [this](boost::system::error_code ec, |
| const IpmbMethodType& response) { |
| const int& status = std::get<0>(response); |
| if (ec || (status != 0)) |
| { |
| incrementError(); |
| read(); |
| return; |
| } |
| const std::vector<uint8_t>& data = std::get<5>(response); |
| if constexpr (debug) |
| { |
| std::cout << name << ": "; |
| for (size_t d : data) |
| { |
| std::cout << d << " "; |
| } |
| std::cout << "\n"; |
| } |
| if (data.empty()) |
| { |
| incrementError(); |
| read(); |
| return; |
| } |
| |
| double value = 0; |
| |
| if (!processReading(data, value)) |
| { |
| incrementError(); |
| read(); |
| return; |
| } |
| |
| // rawValue only used in debug logging |
| // up to 5th byte in data are used to derive value |
| size_t end = std::min(sizeof(uint64_t), data.size()); |
| uint64_t rawData = 0; |
| for (size_t i = 0; i < end; i++) |
| { |
| // NOLINTNEXTLINE(cppcoreguidelines-pro-type-reinterpret-cast) |
| reinterpret_cast<uint8_t*>(&rawData)[i] = data[i]; |
| } |
| rawValue = static_cast<double>(rawData); |
| |
| /* Adjust value as per scale and offset */ |
| value = (value * scaleVal) + offsetVal; |
| updateValue(value); |
| read(); |
| }, |
| "xyz.openbmc_project.Ipmi.Channel.Ipmb", |
| "/xyz/openbmc_project/Ipmi/Channel/Ipmb", "org.openbmc.Ipmb", |
| "sendRequest", commandAddress, netfn, lun, command, commandData); |
| }); |
| } |
| |
| bool IpmbSensor::sensorClassType(const std::string& sensorClass) |
| { |
| if (sensorClass == "PxeBridgeTemp") |
| { |
| type = IpmbType::PXE1410CVR; |
| } |
| else if (sensorClass == "IRBridgeTemp") |
| { |
| type = IpmbType::IR38363VR; |
| } |
| else if (sensorClass == "HSCBridge") |
| { |
| type = IpmbType::ADM1278HSC; |
| } |
| else if (sensorClass == "MpsBridgeTemp") |
| { |
| type = IpmbType::mpsVR; |
| } |
| else if (sensorClass == "METemp" || sensorClass == "MESensor") |
| { |
| type = IpmbType::meSensor; |
| } |
| else |
| { |
| std::cerr << "Invalid class " << sensorClass << "\n"; |
| return false; |
| } |
| return true; |
| } |
| |
| void IpmbSensor::sensorSubType(const std::string& sensorTypeName) |
| { |
| if (sensorTypeName == "voltage") |
| { |
| subType = IpmbSubType::volt; |
| } |
| else if (sensorTypeName == "power") |
| { |
| subType = IpmbSubType::power; |
| } |
| else if (sensorTypeName == "current") |
| { |
| subType = IpmbSubType::curr; |
| } |
| else if (sensorTypeName == "utilization") |
| { |
| subType = IpmbSubType::util; |
| } |
| else |
| { |
| subType = IpmbSubType::temp; |
| } |
| } |
| |
| void IpmbSensor::parseConfigValues(const SensorBaseConfigMap& entry) |
| { |
| auto findScaleVal = entry.find("ScaleValue"); |
| if (findScaleVal != entry.end()) |
| { |
| scaleVal = std::visit(VariantToDoubleVisitor(), findScaleVal->second); |
| } |
| |
| auto findOffsetVal = entry.find("OffsetValue"); |
| if (findOffsetVal != entry.end()) |
| { |
| offsetVal = std::visit(VariantToDoubleVisitor(), findOffsetVal->second); |
| } |
| |
| readState = getPowerState(entry); |
| } |
| |
| void createSensors( |
| boost::asio::io_service& io, sdbusplus::asio::object_server& objectServer, |
| boost::container::flat_map<std::string, std::unique_ptr<IpmbSensor>>& |
| sensors, |
| std::shared_ptr<sdbusplus::asio::connection>& dbusConnection) |
| { |
| if (!dbusConnection) |
| { |
| std::cerr << "Connection not created\n"; |
| return; |
| } |
| dbusConnection->async_method_call( |
| [&](boost::system::error_code ec, const ManagedObjectType& resp) { |
| if (ec) |
| { |
| std::cerr << "Error contacting entity manager\n"; |
| return; |
| } |
| for (const auto& pathPair : resp) |
| { |
| for (const auto& entry : pathPair.second) |
| { |
| if (entry.first != configInterface) |
| { |
| continue; |
| } |
| std::string name = |
| loadVariant<std::string>(entry.second, "Name"); |
| |
| std::vector<thresholds::Threshold> sensorThresholds; |
| if (!parseThresholdsFromConfig(pathPair.second, |
| sensorThresholds)) |
| { |
| std::cerr << "error populating thresholds for " << name |
| << "\n"; |
| } |
| uint8_t deviceAddress = |
| loadVariant<uint8_t>(entry.second, "Address"); |
| |
| std::string sensorClass = |
| loadVariant<std::string>(entry.second, "Class"); |
| |
| uint8_t hostSMbusIndex = hostSMbusIndexDefault; |
| auto findSmType = entry.second.find("HostSMbusIndex"); |
| if (findSmType != entry.second.end()) |
| { |
| hostSMbusIndex = std::visit(VariantToUnsignedIntVisitor(), |
| findSmType->second); |
| } |
| |
| float pollRate = pollRateDefault; |
| auto findPollRate = entry.second.find("PollRate"); |
| if (findPollRate != entry.second.end()) |
| { |
| pollRate = std::visit(VariantToFloatVisitor(), |
| findPollRate->second); |
| if (pollRate <= 0.0F) |
| { |
| pollRate = pollRateDefault; |
| } |
| } |
| |
| /* Default sensor type is "temperature" */ |
| std::string sensorTypeName = "temperature"; |
| auto findType = entry.second.find("SensorType"); |
| if (findType != entry.second.end()) |
| { |
| sensorTypeName = |
| std::visit(VariantToStringVisitor(), findType->second); |
| } |
| |
| auto& sensor = sensors[name]; |
| sensor = std::make_unique<IpmbSensor>( |
| dbusConnection, io, name, pathPair.first, objectServer, |
| std::move(sensorThresholds), deviceAddress, hostSMbusIndex, |
| pollRate, sensorTypeName); |
| |
| sensor->parseConfigValues(entry.second); |
| if (!(sensor->sensorClassType(sensorClass))) |
| { |
| continue; |
| } |
| sensor->sensorSubType(sensorTypeName); |
| sensor->init(); |
| } |
| } |
| }, |
| entityManagerName, "/", "org.freedesktop.DBus.ObjectManager", |
| "GetManagedObjects"); |
| } |
| |
| void reinitSensors(sdbusplus::message::message& message) |
| { |
| constexpr const size_t reinitWaitSeconds = 2; |
| std::string objectName; |
| boost::container::flat_map<std::string, std::variant<std::string>> values; |
| message.read(objectName, values); |
| |
| auto findStatus = values.find(power::property); |
| if (findStatus != values.end()) |
| { |
| bool powerStatus = boost::ends_with( |
| std::get<std::string>(findStatus->second), ".Running"); |
| if (powerStatus) |
| { |
| if (!initCmdTimer) |
| { |
| // this should be impossible |
| return; |
| } |
| // we seem to send this command too fast sometimes, wait before |
| // sending |
| initCmdTimer->expires_from_now( |
| boost::posix_time::seconds(reinitWaitSeconds)); |
| |
| initCmdTimer->async_wait([](const boost::system::error_code ec) { |
| if (ec == boost::asio::error::operation_aborted) |
| { |
| return; // we're being canceled |
| } |
| |
| for (const auto& sensor : sensors) |
| { |
| if (sensor.second) |
| { |
| sensor.second->runInitCmd(); |
| } |
| } |
| }); |
| } |
| } |
| } |
| |
| int main() |
| { |
| |
| boost::asio::io_service io; |
| auto systemBus = std::make_shared<sdbusplus::asio::connection>(io); |
| systemBus->request_name("xyz.openbmc_project.IpmbSensor"); |
| sdbusplus::asio::object_server objectServer(systemBus); |
| |
| initCmdTimer = std::make_unique<boost::asio::deadline_timer>(io); |
| |
| io.post([&]() { createSensors(io, objectServer, sensors, systemBus); }); |
| |
| boost::asio::deadline_timer configTimer(io); |
| |
| std::function<void(sdbusplus::message::message&)> eventHandler = |
| [&](sdbusplus::message::message&) { |
| configTimer.expires_from_now(boost::posix_time::seconds(1)); |
| // create a timer because normally multiple properties change |
| configTimer.async_wait([&](const boost::system::error_code& ec) { |
| if (ec == boost::asio::error::operation_aborted) |
| { |
| return; // we're being canceled |
| } |
| createSensors(io, objectServer, sensors, systemBus); |
| if (sensors.empty()) |
| { |
| std::cout << "Configuration not detected\n"; |
| } |
| }); |
| }; |
| |
| sdbusplus::bus::match::match configMatch( |
| static_cast<sdbusplus::bus::bus&>(*systemBus), |
| "type='signal',member='PropertiesChanged',path_namespace='" + |
| std::string(inventoryPath) + "',arg0namespace='" + configInterface + |
| "'", |
| eventHandler); |
| |
| sdbusplus::bus::match::match powerChangeMatch( |
| static_cast<sdbusplus::bus::bus&>(*systemBus), |
| "type='signal',interface='" + std::string(properties::interface) + |
| "',path='" + std::string(power::path) + "',arg0='" + |
| std::string(power::interface) + "'", |
| reinitSensors); |
| |
| setupManufacturingModeMatch(*systemBus); |
| io.run(); |
| return 0; |
| } |