blob: ca4ae7032c229da6c4b0fb0d677eda4498855e5e [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;
John Wange2efdcc2020-02-12 17:02:06 +080025
26/** @class BIOSAttribute
27 * @brief Provide interfaces to implement specific types of attributes
28 */
29class BIOSAttribute
30{
31 public:
32 /** @brief Construct a bios attribute
33 * @param[in] entry - Json Object
34 * @param[in] dbusHandler - Dbus Handler
35 */
Brad Bishop5079ac42021-08-19 18:35:06 -040036 BIOSAttribute(const Json& entry,
37 pldm::utils::DBusHandler* const dbusHandler);
John Wange2efdcc2020-02-12 17:02:06 +080038
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
Tom Josephca7b2522020-11-18 12:27:11 +053060 * @param[in,out] optAttributeValue - init value of the attribute
John Wange2efdcc2020-02-12 17:02:06 +080061 */
Tom Josephca7b2522020-11-18 12:27:11 +053062 virtual void constructEntry(
63 const BIOSStringTable& stringTable, Table& attrTable,
64 Table& attrValueTable,
65 std::optional<std::variant<int64_t, std::string>> optAttributeValue =
66 std::nullopt) = 0;
John Wange2efdcc2020-02-12 17:02:06 +080067
Sampa Misra46ece062020-03-18 07:17:44 -050068 /** @brief Method to update the value for an attribute
69 * @param[in,out] newValue - An attribute value table row with the new
70 * value for the attribute
71 * @param[in] attrHdl - attribute handle
72 * @param[in] attrType - attribute type
73 * @param[in] newPropVal - The new value
74 * @return PLDM Success or failure status
75 */
76 virtual int updateAttrVal(Table& newValue, uint16_t attrHdl,
77 uint8_t attrType,
Brad Bishop5079ac42021-08-19 18:35:06 -040078 const pldm::utils::PropertyValue& newPropVal) = 0;
Sampa Misra46ece062020-03-18 07:17:44 -050079
George Liu1244acf2020-08-14 09:11:11 +080080 /** @brief Generate attribute entry by the spec DSP0247_1.0.0 Table 14
81 * @param[in] attributevalue - attribute value(Enumeration, String and
82 * Integer)
83 * @param[in,out] attrValueEntry - attribute entry
84 */
85 virtual void generateAttributeEntry(
86 const std::variant<int64_t, std::string>& attributevalue,
87 Table& attrValueEntry) = 0;
88
Sampa Misra46ece062020-03-18 07:17:44 -050089 /** @brief Method to return the D-Bus map */
Brad Bishop5079ac42021-08-19 18:35:06 -040090 std::optional<pldm::utils::DBusMapping> getDBusMap();
Sampa Misra46ece062020-03-18 07:17:44 -050091
John Wange2efdcc2020-02-12 17:02:06 +080092 /** @brief Name of this attribute */
93 const std::string name;
94
95 /** Weather this attribute is read-only */
George Liudaa69232020-09-02 17:22:09 +080096 bool readOnly;
John Wange2efdcc2020-02-12 17:02:06 +080097
George Liu92bb4022020-09-03 14:58:24 +080098 const std::string displayName;
99
100 const std::string helpText;
101
John Wange2efdcc2020-02-12 17:02:06 +0800102 protected:
103 /** @brief dbus backend, nullopt if this attribute is read-only*/
Brad Bishop5079ac42021-08-19 18:35:06 -0400104 std::optional<pldm::utils::DBusMapping> dBusMap;
John Wange2efdcc2020-02-12 17:02:06 +0800105
106 /** @brief dbus handler */
Brad Bishop5079ac42021-08-19 18:35:06 -0400107 pldm::utils::DBusHandler* const dbusHandler;
John Wange2efdcc2020-02-12 17:02:06 +0800108};
109
110} // namespace bios
111} // namespace responder
Sampa Misra46ece062020-03-18 07:17:44 -0500112} // namespace pldm