Patrick Venture | 0b02be9 | 2018-08-31 11:55:55 -0700 | [diff] [blame] | 1 | #include "read_fru_data.hpp" |
| 2 | |
| 3 | #include "fruread.hpp" |
Patrick Venture | 0b02be9 | 2018-08-31 11:55:55 -0700 | [diff] [blame] | 4 | |
Vernon Mauery | e08fbff | 2019-04-03 09:19:34 -0700 | [diff] [blame] | 5 | #include <ipmid/api.hpp> |
Vernon Mauery | 3325024 | 2019-03-12 16:49:26 -0700 | [diff] [blame] | 6 | #include <ipmid/types.hpp> |
Vernon Mauery | 6a98fe7 | 2019-03-11 15:57:48 -0700 | [diff] [blame] | 7 | #include <ipmid/utils.hpp> |
Marri Devender Rao | 0acf057 | 2017-07-03 12:25:47 -0500 | [diff] [blame] | 8 | #include <phosphor-logging/elog-errors.hpp> |
George Liu | 52591a9 | 2024-07-19 09:18:50 +0800 | [diff] [blame] | 9 | #include <phosphor-logging/lg2.hpp> |
William A. Kennington III | 4c00802 | 2018-10-12 17:18:14 -0700 | [diff] [blame] | 10 | #include <sdbusplus/message/types.hpp> |
Patrick Venture | 0b02be9 | 2018-08-31 11:55:55 -0700 | [diff] [blame] | 11 | #include <xyz/openbmc_project/Common/error.hpp> |
| 12 | |
Patrick Williams | fbc6c9d | 2023-05-10 07:50:16 -0500 | [diff] [blame] | 13 | #include <algorithm> |
| 14 | #include <map> |
| 15 | |
Marri Devender Rao | 0acf057 | 2017-07-03 12:25:47 -0500 | [diff] [blame] | 16 | extern const FruMap frus; |
Marri Devender Rao | 0acf057 | 2017-07-03 12:25:47 -0500 | [diff] [blame] | 17 | namespace ipmi |
| 18 | { |
| 19 | namespace fru |
| 20 | { |
William A. Kennington III | 4c00802 | 2018-10-12 17:18:14 -0700 | [diff] [blame] | 21 | |
Marri Devender Rao | 0acf057 | 2017-07-03 12:25:47 -0500 | [diff] [blame] | 22 | using namespace phosphor::logging; |
| 23 | using InternalFailure = |
Willy Tu | 523e2d1 | 2023-09-05 11:36:48 -0700 | [diff] [blame] | 24 | sdbusplus::error::xyz::openbmc_project::common::InternalFailure; |
Lei YU | 4b0ddb6 | 2019-01-25 16:43:50 +0800 | [diff] [blame] | 25 | std::unique_ptr<sdbusplus::bus::match_t> matchPtr |
| 26 | __attribute__((init_priority(101))); |
Marri Devender Rao | 0acf057 | 2017-07-03 12:25:47 -0500 | [diff] [blame] | 27 | |
Marri Devender Rao | 0acf057 | 2017-07-03 12:25:47 -0500 | [diff] [blame] | 28 | namespace cache |
| 29 | { |
Patrick Venture | 0b02be9 | 2018-08-31 11:55:55 -0700 | [diff] [blame] | 30 | // User initiate read FRU info area command followed by |
| 31 | // FRU read command. Also data is read in small chunks of |
| 32 | // the specified offset and count. |
| 33 | // Caching the data which will be invalidated when ever there |
| 34 | // is a change in FRU properties. |
| 35 | FRUAreaMap fruMap; |
| 36 | } // namespace cache |
Marri Devender Rao | 0acf057 | 2017-07-03 12:25:47 -0500 | [diff] [blame] | 37 | /** |
Marri Devender Rao | 18aae1f | 2017-07-26 00:33:26 -0500 | [diff] [blame] | 38 | * @brief Read all the property value's for the specified interface |
| 39 | * from Inventory. |
Marri Devender Rao | 0acf057 | 2017-07-03 12:25:47 -0500 | [diff] [blame] | 40 | * |
Marri Devender Rao | 0acf057 | 2017-07-03 12:25:47 -0500 | [diff] [blame] | 41 | * @param[in] intf Interface |
Marri Devender Rao | 0acf057 | 2017-07-03 12:25:47 -0500 | [diff] [blame] | 42 | * @param[in] path Object path |
Marri Devender Rao | 18aae1f | 2017-07-26 00:33:26 -0500 | [diff] [blame] | 43 | * @return map of properties |
Marri Devender Rao | 0acf057 | 2017-07-03 12:25:47 -0500 | [diff] [blame] | 44 | */ |
Marri Devender Rao | 18aae1f | 2017-07-26 00:33:26 -0500 | [diff] [blame] | 45 | ipmi::PropertyMap readAllProperties(const std::string& intf, |
Patrick Venture | 0b02be9 | 2018-08-31 11:55:55 -0700 | [diff] [blame] | 46 | const std::string& path) |
Marri Devender Rao | 0acf057 | 2017-07-03 12:25:47 -0500 | [diff] [blame] | 47 | { |
Marri Devender Rao | 18aae1f | 2017-07-26 00:33:26 -0500 | [diff] [blame] | 48 | ipmi::PropertyMap properties; |
Patrick Williams | 5d82f47 | 2022-07-22 19:26:53 -0500 | [diff] [blame] | 49 | sdbusplus::bus_t bus{ipmid_get_sd_bus_connection()}; |
Patrick Venture | c26cc71 | 2019-07-25 15:11:59 -0700 | [diff] [blame] | 50 | std::string service; |
| 51 | std::string objPath; |
| 52 | |
| 53 | // Is the path the full dbus path? |
Kirill Pakhomov | b118c4b | 2020-05-08 18:38:26 +0300 | [diff] [blame] | 54 | if (path.find(xyzPrefix) != std::string::npos) |
Patrick Venture | c26cc71 | 2019-07-25 15:11:59 -0700 | [diff] [blame] | 55 | { |
| 56 | service = ipmi::getService(bus, intf, path); |
| 57 | objPath = path; |
| 58 | } |
| 59 | else |
| 60 | { |
Kirill Pakhomov | b118c4b | 2020-05-08 18:38:26 +0300 | [diff] [blame] | 61 | service = ipmi::getService(bus, invMgrInterface, invObjPath); |
| 62 | objPath = invObjPath + path; |
Patrick Venture | c26cc71 | 2019-07-25 15:11:59 -0700 | [diff] [blame] | 63 | } |
| 64 | |
Patrick Venture | 0b02be9 | 2018-08-31 11:55:55 -0700 | [diff] [blame] | 65 | auto method = bus.new_method_call(service.c_str(), objPath.c_str(), |
Kirill Pakhomov | b118c4b | 2020-05-08 18:38:26 +0300 | [diff] [blame] | 66 | propInterface, "GetAll"); |
Marri Devender Rao | 18aae1f | 2017-07-26 00:33:26 -0500 | [diff] [blame] | 67 | method.append(intf); |
Patrick Venture | c26cc71 | 2019-07-25 15:11:59 -0700 | [diff] [blame] | 68 | try |
| 69 | { |
| 70 | auto reply = bus.call(method); |
| 71 | reply.read(properties); |
| 72 | } |
Patrick Williams | 5d82f47 | 2022-07-22 19:26:53 -0500 | [diff] [blame] | 73 | catch (const sdbusplus::exception_t& e) |
Marri Devender Rao | 0acf057 | 2017-07-03 12:25:47 -0500 | [diff] [blame] | 74 | { |
Patrick Venture | 0b02be9 | 2018-08-31 11:55:55 -0700 | [diff] [blame] | 75 | // If property is not found simply return empty value |
George Liu | 52591a9 | 2024-07-19 09:18:50 +0800 | [diff] [blame] | 76 | lg2::error("Error in reading property values: {ERROR}, path: {PATH}, " |
| 77 | "interface: {INTERFACE}", |
| 78 | "ERROR", e, "PATH", objPath, "INTERFACE", intf); |
Marri Devender Rao | 0acf057 | 2017-07-03 12:25:47 -0500 | [diff] [blame] | 79 | } |
Patrick Venture | c26cc71 | 2019-07-25 15:11:59 -0700 | [diff] [blame] | 80 | |
Marri Devender Rao | 18aae1f | 2017-07-26 00:33:26 -0500 | [diff] [blame] | 81 | return properties; |
Marri Devender Rao | 0acf057 | 2017-07-03 12:25:47 -0500 | [diff] [blame] | 82 | } |
| 83 | |
Patrick Williams | 5d82f47 | 2022-07-22 19:26:53 -0500 | [diff] [blame] | 84 | void processFruPropChange(sdbusplus::message_t& msg) |
Marri Devender Rao | 908f750 | 2017-07-10 01:49:54 -0500 | [diff] [blame] | 85 | { |
Patrick Venture | 0b02be9 | 2018-08-31 11:55:55 -0700 | [diff] [blame] | 86 | if (cache::fruMap.empty()) |
Marri Devender Rao | 908f750 | 2017-07-10 01:49:54 -0500 | [diff] [blame] | 87 | { |
| 88 | return; |
| 89 | } |
| 90 | std::string path = msg.get_path(); |
Patrick Venture | 0b02be9 | 2018-08-31 11:55:55 -0700 | [diff] [blame] | 91 | // trim the object base path, if found at the beginning |
Kirill Pakhomov | b118c4b | 2020-05-08 18:38:26 +0300 | [diff] [blame] | 92 | if (path.compare(0, strlen(invObjPath), invObjPath) == 0) |
Marri Devender Rao | 908f750 | 2017-07-10 01:49:54 -0500 | [diff] [blame] | 93 | { |
Kirill Pakhomov | b118c4b | 2020-05-08 18:38:26 +0300 | [diff] [blame] | 94 | path.erase(0, strlen(invObjPath)); |
Marri Devender Rao | 908f750 | 2017-07-10 01:49:54 -0500 | [diff] [blame] | 95 | } |
Patrick Venture | 438fb79 | 2018-10-23 19:51:10 -0700 | [diff] [blame] | 96 | for (const auto& [fruId, instanceList] : frus) |
Marri Devender Rao | 908f750 | 2017-07-10 01:49:54 -0500 | [diff] [blame] | 97 | { |
Patrick Williams | 369824e | 2023-10-20 11:18:23 -0500 | [diff] [blame] | 98 | auto found = std::find_if( |
| 99 | instanceList.begin(), instanceList.end(), |
| 100 | [&path](const auto& iter) { return (iter.path == path); }); |
Patrick Venture | b0431c7 | 2018-10-22 14:57:36 -0700 | [diff] [blame] | 101 | |
| 102 | if (found != instanceList.end()) |
Marri Devender Rao | 908f750 | 2017-07-10 01:49:54 -0500 | [diff] [blame] | 103 | { |
| 104 | cache::fruMap.erase(fruId); |
| 105 | break; |
| 106 | } |
| 107 | } |
| 108 | } |
| 109 | |
Patrick Venture | 0b02be9 | 2018-08-31 11:55:55 -0700 | [diff] [blame] | 110 | // register for fru property change |
Marri Devender Rao | 908f750 | 2017-07-10 01:49:54 -0500 | [diff] [blame] | 111 | int registerCallbackHandler() |
| 112 | { |
Patrick Venture | 0b02be9 | 2018-08-31 11:55:55 -0700 | [diff] [blame] | 113 | if (matchPtr == nullptr) |
Marri Devender Rao | 908f750 | 2017-07-10 01:49:54 -0500 | [diff] [blame] | 114 | { |
| 115 | using namespace sdbusplus::bus::match::rules; |
Patrick Williams | 5d82f47 | 2022-07-22 19:26:53 -0500 | [diff] [blame] | 116 | sdbusplus::bus_t bus{ipmid_get_sd_bus_connection()}; |
Marri Devender Rao | 908f750 | 2017-07-10 01:49:54 -0500 | [diff] [blame] | 117 | matchPtr = std::make_unique<sdbusplus::bus::match_t>( |
| 118 | bus, |
Kirill Pakhomov | b118c4b | 2020-05-08 18:38:26 +0300 | [diff] [blame] | 119 | path_namespace(invObjPath) + type::signal() + |
| 120 | member("PropertiesChanged") + interface(propInterface), |
Marri Devender Rao | 908f750 | 2017-07-10 01:49:54 -0500 | [diff] [blame] | 121 | std::bind(processFruPropChange, std::placeholders::_1)); |
| 122 | } |
| 123 | return 0; |
| 124 | } |
| 125 | |
Marri Devender Rao | 0acf057 | 2017-07-03 12:25:47 -0500 | [diff] [blame] | 126 | /** |
| 127 | * @brief Read FRU property values from Inventory |
| 128 | * |
| 129 | * @param[in] fruNum FRU id |
| 130 | * @return populate FRU Inventory data |
| 131 | */ |
| 132 | FruInventoryData readDataFromInventory(const FRUId& fruNum) |
| 133 | { |
| 134 | auto iter = frus.find(fruNum); |
| 135 | if (iter == frus.end()) |
| 136 | { |
George Liu | 52591a9 | 2024-07-19 09:18:50 +0800 | [diff] [blame] | 137 | lg2::error("Unsupported FRU ID: {FRUID}", "FRUID", fruNum); |
Marri Devender Rao | 0acf057 | 2017-07-03 12:25:47 -0500 | [diff] [blame] | 138 | elog<InternalFailure>(); |
| 139 | } |
| 140 | |
| 141 | FruInventoryData data; |
| 142 | auto& instanceList = iter->second; |
| 143 | for (auto& instance : instanceList) |
| 144 | { |
Ratan Gupta | 0033097 | 2018-01-19 16:23:10 +0530 | [diff] [blame] | 145 | for (auto& intf : instance.interfaces) |
Marri Devender Rao | 0acf057 | 2017-07-03 12:25:47 -0500 | [diff] [blame] | 146 | { |
Patrick Williams | 1318a5e | 2024-08-16 15:19:54 -0400 | [diff] [blame^] | 147 | ipmi::PropertyMap allProp = |
| 148 | readAllProperties(intf.first, instance.path); |
Marri Devender Rao | 18aae1f | 2017-07-26 00:33:26 -0500 | [diff] [blame] | 149 | for (auto& properties : intf.second) |
Marri Devender Rao | 0acf057 | 2017-07-03 12:25:47 -0500 | [diff] [blame] | 150 | { |
Marri Devender Rao | 18aae1f | 2017-07-26 00:33:26 -0500 | [diff] [blame] | 151 | auto iter = allProp.find(properties.first); |
| 152 | if (iter != allProp.end()) |
| 153 | { |
Patrick Venture | 0b02be9 | 2018-08-31 11:55:55 -0700 | [diff] [blame] | 154 | data[properties.second.section].emplace( |
Patrick Venture | 45e93cb | 2019-07-25 15:03:19 -0700 | [diff] [blame] | 155 | properties.second.property, |
| 156 | std::move( |
| 157 | std::get<std::string>(allProp[properties.first]))); |
Marri Devender Rao | 18aae1f | 2017-07-26 00:33:26 -0500 | [diff] [blame] | 158 | } |
Marri Devender Rao | 0acf057 | 2017-07-03 12:25:47 -0500 | [diff] [blame] | 159 | } |
| 160 | } |
| 161 | } |
| 162 | return data; |
| 163 | } |
| 164 | |
| 165 | const FruAreaData& getFruAreaData(const FRUId& fruNum) |
| 166 | { |
| 167 | auto iter = cache::fruMap.find(fruNum); |
| 168 | if (iter != cache::fruMap.end()) |
| 169 | { |
| 170 | return iter->second; |
| 171 | } |
| 172 | auto invData = readDataFromInventory(fruNum); |
| 173 | |
Patrick Venture | 0b02be9 | 2018-08-31 11:55:55 -0700 | [diff] [blame] | 174 | // Build area info based on inventory data |
Marri Devender Rao | 0acf057 | 2017-07-03 12:25:47 -0500 | [diff] [blame] | 175 | FruAreaData newdata = buildFruAreaData(std::move(invData)); |
| 176 | cache::fruMap.emplace(fruNum, std::move(newdata)); |
| 177 | return cache::fruMap.at(fruNum); |
| 178 | } |
Patrick Venture | 0b02be9 | 2018-08-31 11:55:55 -0700 | [diff] [blame] | 179 | } // namespace fru |
| 180 | } // namespace ipmi |