pldm/libpldmresponder/bios_table.hpp

21 using Table = std::vector<uint8_t>;  typedef
30  *  BIOSTable table(BIOS_STRING_TABLE_FILE_PATH);
31  *  if (table.isEmpty()) { // no persisted table
35  *    table.store(t); // persisted
37  *  else { // persisted table exists
39  *    // the table itself) to a GetBIOSTable command
40  *    table.load(r); // actual table will be pushed back to the vector
46     /** @brief Ctor - set file path to persist BIOS table
48      *  @param[in] filePath - file where BIOS table should be persisted
52     /** @brief Checks if there's a persisted BIOS table
54      *  @return bool - true if table exists, false otherwise
58     /** @brief Persist a BIOS table(string/attribute/attribute value)
60      *  @param[in] table - BIOS table
62     void store(const Table& table);
64     /** @brief Load BIOS table from persistent store to memory
67      *  (excluding table), table will be pushed back to this.
72     // file storing PLDM BIOS table
77  *  @brief Provide interfaces to the BIOS string table operations
84     /** @brief Find the string name from the BIOS string table for a string
91     /** @brief Find the string handle from the BIOS string table by the given
100  *  @brief Collection of BIOS string table operations.
109     BIOSStringTable(const Table& stringTable);
117     /** @brief Find the string name from the BIOS string table for a string
125     /** @brief Find the string handle from the BIOS string table by the given
134     Table stringTable;
137 namespace table  namespace
142  *  @param[in,out] table - table to be appended with pad and checksum
144 void appendPadAndChecksum(Table& table);
150  *  @param[in] entry - Pointer to a bios string table entry
151  *  @return Handle to identify a string in the bios string table
156  *  @param[in] entry - Pointer to a bios string table entry
161 /** @brief construct entry of string table at the end of the given
162  *         table
163  *  @param[in,out] table - The given table
168     constructEntry(Table& table, const std::string& str);
176  *  @brief Header of attribute table
185 /** @brief Decode header of attribute table entry
186  *  @param[in] entry - Pointer to an attribute table entry
187  *  @return Attribute table header
192  *  @param[in] table - attribute table
194  *  @return Pointer to the attribute table entry
197     findByHandle(const Table& table, uint16_t handle);
200  *  @param[in] table - attribute table
202  *  @return Pointer to the attribute table entry
205     findByStringHandle(const Table& table, uint16_t handle);
208  *  @brief String field of attribute table
219 /** @brief decode string entry of attribute table
220  *  @param[in] entry - Pointer to an attribute table entry
225 /** @brief construct string entry of attribute table at the end of the given
226  *         table
227  *  @param[in,out] table - The given table
232     Table& table, pldm_bios_table_attr_entry_string_info* info);
235  *  @brief Integer field of attribute table
245 /** @brief construct integer entry of attribute table at the end of the
246  *         given table
247  *  @param[in,out] table - The given table
252     Table& table, pldm_bios_table_attr_entry_integer_info* info);
254 /** @brief decode integer entry of attribute table
255  *  @param[in] entry - Pointer to an attribute table entry
261  *  @brief Enum field of attribute table
269 /** @brief decode enum entry of attribute table
270  *  @param[in] entry - Pointer to an attribute table entry
275 /** @brief construct enum entry of attribute table at the end of the
276  *         given table
277  *  @param[in,out] table - The given table
282     Table& table, pldm_bios_table_attr_entry_enum_info* info);
290  *  @brief Header of attribute value table
298 /** @brief Decode header of attribute value table
299  *  @param[in] entry - Pointer to an attribute value table entry
300  *  @return Attribute value table header
304 /** @brief Decode string entry of attribute value table
305  *  @param[in] entry - Pointer to an attribute value table entry
310 /** @brief Decode integer entry of attribute value table
311  *  @param[in] entry - Pointer to an attribute value table entry
316 /** @brief Decode enum entry of attribute value table
317  *  @param[in] entry - Pointer to an attribute value table entry
323 /** @brief Construct string entry of attribute value table at the end of the
324  *         given table
325  *  @param[in] table - The given table
332     constructStringEntry(Table& table, uint16_t attrHandle, uint8_t attrType,
335 /** @brief Construct integer entry of attribute value table at the end of
336  *         the given table
337  *  @param[in] table - The given table
344     Table& table, uint16_t attrHandle, uint8_t attrType, uint64_t value);
346 /** @brief Construct enum entry of attribute value table at the end of
347  *         the given table
348  *  @param[in] table - The given table
355     constructEnumEntry(Table& table, uint16_t attrHandle, uint8_t attrType,
358 /** @brief construct a table with an new entry
359  *  @param[in] table - the table need to be updated
362  *  @return newly constructed table, std::nullopt if failed
364 std::optional<Table> updateTable(const Table& table, const void* entry,
369 } // namespace table