blob: d7124294f3b13f99f985ca131f8100a924e4bdce [file] [log] [blame]
John Wange2efdcc2020-02-12 17:02:06 +08001#pragma once
2
George Liu6492f522020-06-16 10:34:05 +08003#include "bios_table.h"
4
John Wange2efdcc2020-02-12 17:02:06 +08005#include "bios_table.hpp"
Deepak Kodihallid130e1a2020-06-17 05:55:32 -05006#include "common/utils.hpp"
John Wange2efdcc2020-02-12 17:02:06 +08007
George Liu6492f522020-06-16 10:34:05 +08008#include <nlohmann/json.hpp>
9
John Wange2efdcc2020-02-12 17:02:06 +080010#include <cstdint>
11#include <filesystem>
12#include <memory>
John Wange2efdcc2020-02-12 17:02:06 +080013#include <optional>
14#include <string>
15#include <vector>
16
John Wange2efdcc2020-02-12 17:02:06 +080017namespace pldm
18{
19namespace responder
20{
21namespace bios
22{
23
24using Json = nlohmann::json;
25using namespace pldm::utils;
26
27/** @class BIOSAttribute
28 * @brief Provide interfaces to implement specific types of attributes
29 */
30class BIOSAttribute
31{
32 public:
33 /** @brief Construct a bios attribute
34 * @param[in] entry - Json Object
35 * @param[in] dbusHandler - Dbus Handler
36 */
37 BIOSAttribute(const Json& entry, DBusHandler* const dbusHandler);
38
39 /** Virtual destructor
40 */
41 virtual ~BIOSAttribute() = default;
42
43 /** @brief Set Attribute value On Dbus according to the attribute value
44 * entry
45 * @param[in] attrValueEntry - The attribute value entry
46 * @param[in] attrEntry - The attribute entry corresponding to the
47 * attribute value entry
48 * @param[in] stringTable - The string table
49 */
50 virtual void
51 setAttrValueOnDbus(const pldm_bios_attr_val_table_entry* attrValueEntry,
52 const pldm_bios_attr_table_entry* attrEntry,
53 const BIOSStringTable& stringTable) = 0;
54
55 /** @brief Construct corresponding entries at the end of the attribute table
56 * and attribute value tables
57 * @param[in] stringTable - The string Table
58 * @param[in,out] attrTable - The attribute table
59 * @param[in,out] attrValueTable - The attribute value table
60 */
61 virtual void constructEntry(const BIOSStringTable& stringTable,
62 Table& attrTable, Table& attrValueTable) = 0;
63
Sampa Misra46ece062020-03-18 07:17:44 -050064 /** @brief Method to update the value for an attribute
65 * @param[in,out] newValue - An attribute value table row with the new
66 * value for the attribute
67 * @param[in] attrHdl - attribute handle
68 * @param[in] attrType - attribute type
69 * @param[in] newPropVal - The new value
70 * @return PLDM Success or failure status
71 */
72 virtual int updateAttrVal(Table& newValue, uint16_t attrHdl,
73 uint8_t attrType,
74 const PropertyValue& newPropVal) = 0;
75
George Liu1244acf2020-08-14 09:11:11 +080076 /** @brief Generate attribute entry by the spec DSP0247_1.0.0 Table 14
77 * @param[in] attributevalue - attribute value(Enumeration, String and
78 * Integer)
79 * @param[in,out] attrValueEntry - attribute entry
80 */
81 virtual void generateAttributeEntry(
82 const std::variant<int64_t, std::string>& attributevalue,
83 Table& attrValueEntry) = 0;
84
Sampa Misra46ece062020-03-18 07:17:44 -050085 /** @brief Method to return the D-Bus map */
86 std::optional<DBusMapping> getDBusMap();
87
John Wange2efdcc2020-02-12 17:02:06 +080088 /** @brief Name of this attribute */
89 const std::string name;
90
91 /** Weather this attribute is read-only */
George Liudaa69232020-09-02 17:22:09 +080092 bool readOnly;
John Wange2efdcc2020-02-12 17:02:06 +080093
George Liu92bb4022020-09-03 14:58:24 +080094 const std::string displayName;
95
96 const std::string helpText;
97
John Wange2efdcc2020-02-12 17:02:06 +080098 protected:
99 /** @brief dbus backend, nullopt if this attribute is read-only*/
100 std::optional<DBusMapping> dBusMap;
101
102 /** @brief dbus handler */
103 DBusHandler* const dbusHandler;
104};
105
106} // namespace bios
107} // namespace responder
Sampa Misra46ece062020-03-18 07:17:44 -0500108} // namespace pldm