src/fru_device/fru_utils.hpp

25 using DeviceMap = std::flat_map<int, std::vector<uint8_t>>;
26 using BusMap = std::flat_map<int, std::shared_ptr<DeviceMap>>;
64 const std::vector<std::string> fruAreaNames = {"INTERNAL", "CHASSIS", "BOARD",
66 const std::regex nonAsciiRegex("[^\x01-\x7f]");
68 const std::vector<std::string> chassisFruAreas = {"PART_NUMBER",
71 const std::vector<std::string> boardFruAreas = {
75 const std::vector<std::string> productFruAreas = {
79 const std::string fruCustomFieldName = "INFO_AM";
84                std::underlying_type<fruAreas>::type(x) + 1);  in operator ++()
87 inline const std::string& getFruAreaName(fruAreas area)  in getFruAreaName()
92 std::tm intelEpoch();
97 constexpr std::array<char, 6> bcdHighChars = {
103 bool verifyOffset(std::span<const uint8_t> fruBytes, fruAreas currentArea,
106 std::pair<DecodeState, std::string> decodeFRUData(
107     std::span<const uint8_t>::const_iterator& iter,
108     std::span<const uint8_t>::const_iterator& end, bool isLangEng);
113     std::span<const uint8_t> fruBytes,
114     std::flat_map<std::string, std::string, std::less<>>& result);
116 std::vector<uint8_t>& getFRUInfo(const uint16_t& bus, const uint8_t& address);
118 uint8_t calculateChecksum(std::span<const uint8_t>::const_iterator iter,
119                           std::span<const uint8_t>::const_iterator end);
121 uint8_t calculateChecksum(std::span<const uint8_t> fruAreaData);
124     std::vector<uint8_t>& fruData, size_t fruAreaStart,
132     std::array<uint8_t, I2C_SMBUS_BLOCK_MAX> ipmiFruBlock;
145 std::optional<FruSections> findFRUHeader(
146     FRUReader& reader, const std::string& errorHelp, off_t offset);
153 std::pair<std::vector<uint8_t>, bool> readFRUContents(
154     FRUReader& reader, const std::string& errorHelp);
159 bool validateHeader(const std::array<uint8_t, I2C_SMBUS_BLOCK_MAX>& blockData);
174 bool findFruAreaLocationAndField(std::vector<uint8_t>& fruData,
175                                  const std::string& propertyName,
189 bool copyRestFRUArea(std::vector<uint8_t>& fruData,
190                      const std::string& propertyName,
192                      std::vector<uint8_t>& restFRUAreaFieldsData);
200 std::optional<int> findIndexForFRU(
201     std::flat_map<std::pair<size_t, size_t>,
202                   std::shared_ptr<sdbusplus::asio::dbus_interface>>&
204     std::string& productName);
215 std::optional<std::string> getProductName(
216     std::vector<uint8_t>& device,
217     std::flat_map<std::string, std::string, std::less<>>& formattedFRU,
220 bool getFruData(std::vector<uint8_t>& fruData, uint32_t bus, uint32_t address);
222 bool isFieldEditable(std::string_view fieldName);
224 bool updateAreaChecksum(std::vector<uint8_t>& fruArea);
226 bool disassembleFruData(std::vector<uint8_t>& fruData,
227                         std::vector<std::vector<uint8_t>>& areasData);
229 bool createDummyArea(fruAreas fruArea, std::vector<uint8_t>& areaData);
231 bool assembleFruData(std::vector<uint8_t>& fruData,
232                      const std::vector<std::vector<uint8_t>>& areasData);
234 bool setField(const fruAreas& fruAreaToUpdate, std::vector<uint8_t>& areaData,
235               const std::string& propertyName, const std::string& value);
237 bool updateAddProperty(const std::string& propertyValue,
238                        const std::string& propertyName,
239                        std::vector<uint8_t>& fruData);
241 std::string parseMacFromGzipXmlHeader(FRUReader& reader, off_t offset);