xref: /openbmc/openpower-pnor-code-mgmt/ubi/serialize.hpp (revision f3dfe65de8487364c21b7b49396cf912821ea339)
1 #pragma once
2 
3 #include <string>
4 
5 namespace openpower
6 {
7 namespace software
8 {
9 namespace updater
10 {
11 
12 /** @brief Serialization function - stores activation information to file
13  *  @param[in] versionId - The version for which to store information.
14  *  @param[in] priority - RedundancyPriority value for that version.
15  */
16 void storeToFile(const std::string& versionId, uint8_t priority);
17 
18 /** @brief Serialization function - restores activation information from file
19  *  @param[in] versionId - The version for which to retrieve information.
20  *  @param[in] priority - RedundancyPriority pointer for that version.
21  *  @return true if restore was successful, false if not
22  */
23 bool restoreFromFile(const std::string& versionId, uint8_t& priority);
24 
25 /** @brief Removes the serial file for a given version.
26  *  @param[in] versionId - The version for which to remove a file, if it exists.
27  */
28 void removeFile(const std::string& versionId);
29 
30 } // namespace updater
31 } // namespace software
32 } // namespace openpower
33