1*e7d23d0eSVijay Khemka /* 2*e7d23d0eSVijay Khemka * Copyright (c) 2018 Intel Corporation. 3*e7d23d0eSVijay Khemka * Copyright (c) 2018-present Facebook. 4*e7d23d0eSVijay Khemka * 5*e7d23d0eSVijay Khemka * Licensed under the Apache License, Version 2.0 (the "License"); 6*e7d23d0eSVijay Khemka * you may not use this file except in compliance with the License. 7*e7d23d0eSVijay Khemka * You may obtain a copy of the License at 8*e7d23d0eSVijay Khemka * 9*e7d23d0eSVijay Khemka * http://www.apache.org/licenses/LICENSE-2.0 10*e7d23d0eSVijay Khemka * 11*e7d23d0eSVijay Khemka * Unless required by applicable law or agreed to in writing, software 12*e7d23d0eSVijay Khemka * distributed under the License is distributed on an "AS IS" BASIS, 13*e7d23d0eSVijay Khemka * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14*e7d23d0eSVijay Khemka * See the License for the specific language governing permissions and 15*e7d23d0eSVijay Khemka * limitations under the License. 16*e7d23d0eSVijay Khemka */ 17*e7d23d0eSVijay Khemka 18*e7d23d0eSVijay Khemka #pragma once 19*e7d23d0eSVijay Khemka #include <ipmid/api.h> 20*e7d23d0eSVijay Khemka 21*e7d23d0eSVijay Khemka #include <cmath> 22*e7d23d0eSVijay Khemka #include <iostream> 23*e7d23d0eSVijay Khemka #include <phosphor-logging/log.hpp> 24*e7d23d0eSVijay Khemka 25*e7d23d0eSVijay Khemka namespace ipmi 26*e7d23d0eSVijay Khemka { 27*e7d23d0eSVijay Khemka 28*e7d23d0eSVijay Khemka static constexpr int16_t maxInt10 = 0x1FF; 29*e7d23d0eSVijay Khemka static constexpr int16_t minInt10 = -0x200; 30*e7d23d0eSVijay Khemka static constexpr int8_t maxInt4 = 7; 31*e7d23d0eSVijay Khemka static constexpr int8_t minInt4 = -8; 32*e7d23d0eSVijay Khemka 33*e7d23d0eSVijay Khemka enum class SensorUnits : uint8_t 34*e7d23d0eSVijay Khemka { 35*e7d23d0eSVijay Khemka unspecified = 0x0, 36*e7d23d0eSVijay Khemka degreesC = 0x1, 37*e7d23d0eSVijay Khemka volts = 0x4, 38*e7d23d0eSVijay Khemka amps = 0x5, 39*e7d23d0eSVijay Khemka watts = 0x6, 40*e7d23d0eSVijay Khemka rpm = 0x12, 41*e7d23d0eSVijay Khemka }; 42*e7d23d0eSVijay Khemka 43*e7d23d0eSVijay Khemka enum class SensorTypeCodes : uint8_t 44*e7d23d0eSVijay Khemka { 45*e7d23d0eSVijay Khemka reserved = 0x0, 46*e7d23d0eSVijay Khemka temperature = 0x1, 47*e7d23d0eSVijay Khemka voltage = 0x2, 48*e7d23d0eSVijay Khemka current = 0x3, 49*e7d23d0eSVijay Khemka fan = 0x4, 50*e7d23d0eSVijay Khemka other = 0xB, 51*e7d23d0eSVijay Khemka }; 52*e7d23d0eSVijay Khemka 53*e7d23d0eSVijay Khemka struct CmpStrVersion 54*e7d23d0eSVijay Khemka { 55*e7d23d0eSVijay Khemka bool operator()(std::string a, std::string b) const 56*e7d23d0eSVijay Khemka { 57*e7d23d0eSVijay Khemka return strverscmp(a.c_str(), b.c_str()) < 0; 58*e7d23d0eSVijay Khemka } 59*e7d23d0eSVijay Khemka }; 60*e7d23d0eSVijay Khemka 61*e7d23d0eSVijay Khemka using SensorSubTree = boost::container::flat_map< 62*e7d23d0eSVijay Khemka std::string, 63*e7d23d0eSVijay Khemka boost::container::flat_map<std::string, std::vector<std::string>>, 64*e7d23d0eSVijay Khemka CmpStrVersion>; 65*e7d23d0eSVijay Khemka 66*e7d23d0eSVijay Khemka inline static bool getSensorSubtree(SensorSubTree &subtree) 67*e7d23d0eSVijay Khemka { 68*e7d23d0eSVijay Khemka sd_bus *bus = NULL; 69*e7d23d0eSVijay Khemka int ret = sd_bus_default_system(&bus); 70*e7d23d0eSVijay Khemka if (ret < 0) 71*e7d23d0eSVijay Khemka { 72*e7d23d0eSVijay Khemka phosphor::logging::log<phosphor::logging::level::ERR>( 73*e7d23d0eSVijay Khemka "Failed to connect to system bus", 74*e7d23d0eSVijay Khemka phosphor::logging::entry("ERRNO=0x%X", -ret)); 75*e7d23d0eSVijay Khemka sd_bus_unref(bus); 76*e7d23d0eSVijay Khemka return false; 77*e7d23d0eSVijay Khemka } 78*e7d23d0eSVijay Khemka sdbusplus::bus::bus dbus(bus); 79*e7d23d0eSVijay Khemka auto mapperCall = 80*e7d23d0eSVijay Khemka dbus.new_method_call("xyz.openbmc_project.ObjectMapper", 81*e7d23d0eSVijay Khemka "/xyz/openbmc_project/object_mapper", 82*e7d23d0eSVijay Khemka "xyz.openbmc_project.ObjectMapper", "GetSubTree"); 83*e7d23d0eSVijay Khemka static constexpr const auto depth = 2; 84*e7d23d0eSVijay Khemka static constexpr std::array<const char *, 3> interfaces = { 85*e7d23d0eSVijay Khemka "xyz.openbmc_project.Sensor.Value", 86*e7d23d0eSVijay Khemka "xyz.openbmc_project.Sensor.Threshold.Warning", 87*e7d23d0eSVijay Khemka "xyz.openbmc_project.Sensor.Threshold.Critical"}; 88*e7d23d0eSVijay Khemka mapperCall.append("/xyz/openbmc_project/sensors", depth, interfaces); 89*e7d23d0eSVijay Khemka 90*e7d23d0eSVijay Khemka try 91*e7d23d0eSVijay Khemka { 92*e7d23d0eSVijay Khemka auto mapperReply = dbus.call(mapperCall); 93*e7d23d0eSVijay Khemka subtree.clear(); 94*e7d23d0eSVijay Khemka mapperReply.read(subtree); 95*e7d23d0eSVijay Khemka } 96*e7d23d0eSVijay Khemka catch (sdbusplus::exception_t &e) 97*e7d23d0eSVijay Khemka { 98*e7d23d0eSVijay Khemka phosphor::logging::log<phosphor::logging::level::ERR>(e.what()); 99*e7d23d0eSVijay Khemka return false; 100*e7d23d0eSVijay Khemka } 101*e7d23d0eSVijay Khemka return true; 102*e7d23d0eSVijay Khemka } 103*e7d23d0eSVijay Khemka 104*e7d23d0eSVijay Khemka // Specify the comparison required to sort and find char* map objects 105*e7d23d0eSVijay Khemka struct CmpStr 106*e7d23d0eSVijay Khemka { 107*e7d23d0eSVijay Khemka bool operator()(const char *a, const char *b) const 108*e7d23d0eSVijay Khemka { 109*e7d23d0eSVijay Khemka return std::strcmp(a, b) < 0; 110*e7d23d0eSVijay Khemka } 111*e7d23d0eSVijay Khemka }; 112*e7d23d0eSVijay Khemka 113*e7d23d0eSVijay Khemka const static boost::container::flat_map<const char *, SensorUnits, CmpStr> 114*e7d23d0eSVijay Khemka sensorUnits{{{"temperature", SensorUnits::degreesC}, 115*e7d23d0eSVijay Khemka {"voltage", SensorUnits::volts}, 116*e7d23d0eSVijay Khemka {"current", SensorUnits::amps}, 117*e7d23d0eSVijay Khemka {"fan_tach", SensorUnits::rpm}, 118*e7d23d0eSVijay Khemka {"power", SensorUnits::watts}}}; 119*e7d23d0eSVijay Khemka 120*e7d23d0eSVijay Khemka const static boost::container::flat_map<const char *, SensorTypeCodes, CmpStr> 121*e7d23d0eSVijay Khemka sensorTypes{{{"temperature", SensorTypeCodes::temperature}, 122*e7d23d0eSVijay Khemka {"voltage", SensorTypeCodes::voltage}, 123*e7d23d0eSVijay Khemka {"current", SensorTypeCodes::current}, 124*e7d23d0eSVijay Khemka {"fan_tach", SensorTypeCodes::fan}, 125*e7d23d0eSVijay Khemka {"fan_pwm", SensorTypeCodes::fan}, 126*e7d23d0eSVijay Khemka {"power", SensorTypeCodes::other}}}; 127*e7d23d0eSVijay Khemka 128*e7d23d0eSVijay Khemka inline static std::string getSensorTypeStringFromPath(const std::string &path) 129*e7d23d0eSVijay Khemka { 130*e7d23d0eSVijay Khemka // get sensor type string from path, path is defined as 131*e7d23d0eSVijay Khemka // /xyz/openbmc_project/sensors/<type>/label 132*e7d23d0eSVijay Khemka size_t typeEnd = path.rfind("/"); 133*e7d23d0eSVijay Khemka if (typeEnd == std::string::npos) 134*e7d23d0eSVijay Khemka { 135*e7d23d0eSVijay Khemka return path; 136*e7d23d0eSVijay Khemka } 137*e7d23d0eSVijay Khemka size_t typeStart = path.rfind("/", typeEnd - 1); 138*e7d23d0eSVijay Khemka if (typeStart == std::string::npos) 139*e7d23d0eSVijay Khemka { 140*e7d23d0eSVijay Khemka return path; 141*e7d23d0eSVijay Khemka } 142*e7d23d0eSVijay Khemka // Start at the character after the '/' 143*e7d23d0eSVijay Khemka typeStart++; 144*e7d23d0eSVijay Khemka return path.substr(typeStart, typeEnd - typeStart); 145*e7d23d0eSVijay Khemka } 146*e7d23d0eSVijay Khemka 147*e7d23d0eSVijay Khemka inline static uint8_t getSensorTypeFromPath(const std::string &path) 148*e7d23d0eSVijay Khemka { 149*e7d23d0eSVijay Khemka uint8_t sensorType = 0; 150*e7d23d0eSVijay Khemka std::string type = getSensorTypeStringFromPath(path); 151*e7d23d0eSVijay Khemka auto findSensor = sensorTypes.find(type.c_str()); 152*e7d23d0eSVijay Khemka if (findSensor != sensorTypes.end()) 153*e7d23d0eSVijay Khemka { 154*e7d23d0eSVijay Khemka sensorType = static_cast<uint8_t>(findSensor->second); 155*e7d23d0eSVijay Khemka } // else default 0x0 RESERVED 156*e7d23d0eSVijay Khemka 157*e7d23d0eSVijay Khemka return sensorType; 158*e7d23d0eSVijay Khemka } 159*e7d23d0eSVijay Khemka 160*e7d23d0eSVijay Khemka inline static uint8_t getSensorEventTypeFromPath(const std::string &path) 161*e7d23d0eSVijay Khemka { 162*e7d23d0eSVijay Khemka // TODO: Add support for additional reading types as needed 163*e7d23d0eSVijay Khemka return 0x1; // reading type = threshold 164*e7d23d0eSVijay Khemka } 165*e7d23d0eSVijay Khemka 166*e7d23d0eSVijay Khemka static inline bool getSensorAttributes(const double max, const double min, 167*e7d23d0eSVijay Khemka int16_t &mValue, int8_t &rExp, 168*e7d23d0eSVijay Khemka int16_t &bValue, int8_t &bExp, 169*e7d23d0eSVijay Khemka bool &bSigned) 170*e7d23d0eSVijay Khemka { 171*e7d23d0eSVijay Khemka // computing y = (10^rRexp) * (Mx + (B*(10^Bexp))) 172*e7d23d0eSVijay Khemka // check for 0, assume always positive 173*e7d23d0eSVijay Khemka double mDouble; 174*e7d23d0eSVijay Khemka double bDouble; 175*e7d23d0eSVijay Khemka if (max <= min) 176*e7d23d0eSVijay Khemka { 177*e7d23d0eSVijay Khemka phosphor::logging::log<phosphor::logging::level::DEBUG>( 178*e7d23d0eSVijay Khemka "getSensorAttributes: Max must be greater than min"); 179*e7d23d0eSVijay Khemka return false; 180*e7d23d0eSVijay Khemka } 181*e7d23d0eSVijay Khemka 182*e7d23d0eSVijay Khemka mDouble = (max - min) / 0xFF; 183*e7d23d0eSVijay Khemka 184*e7d23d0eSVijay Khemka if (min < 0) 185*e7d23d0eSVijay Khemka { 186*e7d23d0eSVijay Khemka bSigned = true; 187*e7d23d0eSVijay Khemka bDouble = floor(0.5 + ((max + min) / 2)); 188*e7d23d0eSVijay Khemka } 189*e7d23d0eSVijay Khemka else 190*e7d23d0eSVijay Khemka { 191*e7d23d0eSVijay Khemka bSigned = false; 192*e7d23d0eSVijay Khemka bDouble = min; 193*e7d23d0eSVijay Khemka } 194*e7d23d0eSVijay Khemka 195*e7d23d0eSVijay Khemka rExp = 0; 196*e7d23d0eSVijay Khemka 197*e7d23d0eSVijay Khemka // M too big for 10 bit variable 198*e7d23d0eSVijay Khemka while (mDouble > maxInt10) 199*e7d23d0eSVijay Khemka { 200*e7d23d0eSVijay Khemka if (rExp >= maxInt4) 201*e7d23d0eSVijay Khemka { 202*e7d23d0eSVijay Khemka phosphor::logging::log<phosphor::logging::level::DEBUG>( 203*e7d23d0eSVijay Khemka "rExp Too big, Max and Min range too far", 204*e7d23d0eSVijay Khemka phosphor::logging::entry("REXP=%d", rExp)); 205*e7d23d0eSVijay Khemka return false; 206*e7d23d0eSVijay Khemka } 207*e7d23d0eSVijay Khemka mDouble /= 10; 208*e7d23d0eSVijay Khemka rExp++; 209*e7d23d0eSVijay Khemka } 210*e7d23d0eSVijay Khemka 211*e7d23d0eSVijay Khemka // M too small, loop until we lose less than 1 eight bit count of precision 212*e7d23d0eSVijay Khemka while (((mDouble - floor(mDouble)) / mDouble) > (1.0 / 255)) 213*e7d23d0eSVijay Khemka { 214*e7d23d0eSVijay Khemka if (rExp <= minInt4) 215*e7d23d0eSVijay Khemka { 216*e7d23d0eSVijay Khemka phosphor::logging::log<phosphor::logging::level::DEBUG>( 217*e7d23d0eSVijay Khemka "rExp Too Small, Max and Min range too close"); 218*e7d23d0eSVijay Khemka return false; 219*e7d23d0eSVijay Khemka } 220*e7d23d0eSVijay Khemka // check to see if we reached the limit of where we can adjust back the 221*e7d23d0eSVijay Khemka // B value 222*e7d23d0eSVijay Khemka if (bDouble / std::pow(10, rExp + minInt4 - 1) > bDouble) 223*e7d23d0eSVijay Khemka { 224*e7d23d0eSVijay Khemka if (mDouble < 1.0) 225*e7d23d0eSVijay Khemka { 226*e7d23d0eSVijay Khemka phosphor::logging::log<phosphor::logging::level::DEBUG>( 227*e7d23d0eSVijay Khemka "Could not find mValue and B value with enough " 228*e7d23d0eSVijay Khemka "precision."); 229*e7d23d0eSVijay Khemka return false; 230*e7d23d0eSVijay Khemka } 231*e7d23d0eSVijay Khemka break; 232*e7d23d0eSVijay Khemka } 233*e7d23d0eSVijay Khemka // can't multiply M any more, max precision reached 234*e7d23d0eSVijay Khemka else if (mDouble * 10 > maxInt10) 235*e7d23d0eSVijay Khemka { 236*e7d23d0eSVijay Khemka break; 237*e7d23d0eSVijay Khemka } 238*e7d23d0eSVijay Khemka mDouble *= 10; 239*e7d23d0eSVijay Khemka rExp--; 240*e7d23d0eSVijay Khemka } 241*e7d23d0eSVijay Khemka 242*e7d23d0eSVijay Khemka bDouble /= std::pow(10, rExp); 243*e7d23d0eSVijay Khemka bExp = 0; 244*e7d23d0eSVijay Khemka 245*e7d23d0eSVijay Khemka // B too big for 10 bit variable 246*e7d23d0eSVijay Khemka while (bDouble > maxInt10 || bDouble < minInt10) 247*e7d23d0eSVijay Khemka { 248*e7d23d0eSVijay Khemka if (bExp >= maxInt4) 249*e7d23d0eSVijay Khemka { 250*e7d23d0eSVijay Khemka phosphor::logging::log<phosphor::logging::level::DEBUG>( 251*e7d23d0eSVijay Khemka "bExp Too Big, Max and Min range need to be adjusted"); 252*e7d23d0eSVijay Khemka return false; 253*e7d23d0eSVijay Khemka } 254*e7d23d0eSVijay Khemka bDouble /= 10; 255*e7d23d0eSVijay Khemka bExp++; 256*e7d23d0eSVijay Khemka } 257*e7d23d0eSVijay Khemka 258*e7d23d0eSVijay Khemka while (((fabs(bDouble) - floor(fabs(bDouble))) / fabs(bDouble)) > 259*e7d23d0eSVijay Khemka (1.0 / 255)) 260*e7d23d0eSVijay Khemka { 261*e7d23d0eSVijay Khemka if (bExp <= minInt4) 262*e7d23d0eSVijay Khemka { 263*e7d23d0eSVijay Khemka phosphor::logging::log<phosphor::logging::level::DEBUG>( 264*e7d23d0eSVijay Khemka "bExp Too Small, Max and Min range need to be adjusted"); 265*e7d23d0eSVijay Khemka return false; 266*e7d23d0eSVijay Khemka } 267*e7d23d0eSVijay Khemka bDouble *= 10; 268*e7d23d0eSVijay Khemka bExp -= 1; 269*e7d23d0eSVijay Khemka } 270*e7d23d0eSVijay Khemka 271*e7d23d0eSVijay Khemka mValue = static_cast<int16_t>(mDouble) & maxInt10; 272*e7d23d0eSVijay Khemka bValue = static_cast<int16_t>(bDouble) & maxInt10; 273*e7d23d0eSVijay Khemka 274*e7d23d0eSVijay Khemka return true; 275*e7d23d0eSVijay Khemka } 276*e7d23d0eSVijay Khemka 277*e7d23d0eSVijay Khemka static inline uint8_t 278*e7d23d0eSVijay Khemka scaleIPMIValueFromDouble(const double value, const uint16_t mValue, 279*e7d23d0eSVijay Khemka const int8_t rExp, const uint16_t bValue, 280*e7d23d0eSVijay Khemka const int8_t bExp, const bool bSigned) 281*e7d23d0eSVijay Khemka { 282*e7d23d0eSVijay Khemka uint32_t scaledValue = 283*e7d23d0eSVijay Khemka (value - (bValue * std::pow(10, bExp) * std::pow(10, rExp))) / 284*e7d23d0eSVijay Khemka (mValue * std::pow(10, rExp)); 285*e7d23d0eSVijay Khemka 286*e7d23d0eSVijay Khemka if (scaledValue > std::numeric_limits<uint8_t>::max() || 287*e7d23d0eSVijay Khemka scaledValue < std::numeric_limits<uint8_t>::lowest()) 288*e7d23d0eSVijay Khemka { 289*e7d23d0eSVijay Khemka throw std::out_of_range("Value out of range"); 290*e7d23d0eSVijay Khemka } 291*e7d23d0eSVijay Khemka if (bSigned) 292*e7d23d0eSVijay Khemka { 293*e7d23d0eSVijay Khemka return static_cast<int8_t>(scaledValue); 294*e7d23d0eSVijay Khemka } 295*e7d23d0eSVijay Khemka else 296*e7d23d0eSVijay Khemka { 297*e7d23d0eSVijay Khemka return static_cast<uint8_t>(scaledValue); 298*e7d23d0eSVijay Khemka } 299*e7d23d0eSVijay Khemka } 300*e7d23d0eSVijay Khemka 301*e7d23d0eSVijay Khemka static inline uint8_t getScaledIPMIValue(const double value, const double max, 302*e7d23d0eSVijay Khemka const double min) 303*e7d23d0eSVijay Khemka { 304*e7d23d0eSVijay Khemka int16_t mValue = 0; 305*e7d23d0eSVijay Khemka int8_t rExp = 0; 306*e7d23d0eSVijay Khemka int16_t bValue = 0; 307*e7d23d0eSVijay Khemka int8_t bExp = 0; 308*e7d23d0eSVijay Khemka bool bSigned = 0; 309*e7d23d0eSVijay Khemka bool result = 0; 310*e7d23d0eSVijay Khemka 311*e7d23d0eSVijay Khemka result = getSensorAttributes(max, min, mValue, rExp, bValue, bExp, bSigned); 312*e7d23d0eSVijay Khemka if (!result) 313*e7d23d0eSVijay Khemka { 314*e7d23d0eSVijay Khemka throw std::runtime_error("Illegal sensor attributes"); 315*e7d23d0eSVijay Khemka } 316*e7d23d0eSVijay Khemka return scaleIPMIValueFromDouble(value, mValue, rExp, bValue, bExp, bSigned); 317*e7d23d0eSVijay Khemka } 318*e7d23d0eSVijay Khemka } // namespace ipmi 319