1 /**
2  * Copyright © 2020 IBM Corporation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 #pragma once
17 
18 #include "action.hpp"
19 #include "action_environment.hpp"
20 
21 #include <cstdint>
22 #include <string>
23 #include <vector>
24 
25 namespace phosphor::power::regulators
26 {
27 
28 /**
29  * @class CompareVPDAction
30  *
31  * Compares a VPD (Vital Product Data) keyword value to an expected value.
32  *
33  * Implements the compare_vpd action in the JSON config file.
34  */
35 class CompareVPDAction : public Action
36 {
37   public:
38     // Specify which compiler-generated methods we want
39     CompareVPDAction() = delete;
40     CompareVPDAction(const CompareVPDAction&) = delete;
41     CompareVPDAction(CompareVPDAction&&) = delete;
42     CompareVPDAction& operator=(const CompareVPDAction&) = delete;
43     CompareVPDAction& operator=(CompareVPDAction&&) = delete;
44     virtual ~CompareVPDAction() = default;
45 
46     /**
47      * Constructor.
48      *
49      * @param fru Field-Replaceable Unit (FRU). Specify the D-Bus inventory path
50      *            of the FRU.
51      * @param keyword VPD keyword. Specify one of the following: "CCIN",
52      *                "Manufacturer", "Model", "PartNumber".
53      * @param value Expected value
54      */
55     explicit CompareVPDAction(const std::string& fru,
56                               const std::string& keyword,
57                               const std::vector<uint8_t>& value) :
58         fru{fru},
59         keyword{keyword}, value{value}
60     {
61     }
62 
63     /**
64      * Executes this action.
65      *
66      * Compares the actual VPD keyword value to the expected value.
67      *
68      * Throws an exception if an error occurs.
69      *
70      * @param environment action execution environment
71      * @return true if the keyword value equals the expected value, otherwise
72      *         returns false
73      */
74     virtual bool execute(ActionEnvironment& environment) override;
75 
76     /**
77      * Returns the Field-Replaceable Unit (FRU).
78      *
79      * @return FRU
80      */
81     const std::string& getFRU() const
82     {
83         return fru;
84     }
85 
86     /**
87      * Returns the VPD keyword.
88      *
89      * @return keyword
90      */
91     const std::string& getKeyword() const
92     {
93         return keyword;
94     }
95 
96     /**
97      * Returns the expected value.
98      *
99      * @return value
100      */
101     const std::vector<uint8_t>& getValue() const
102     {
103         return value;
104     }
105 
106     /**
107      * Returns a string description of this action.
108      *
109      * @return description of action
110      */
111     virtual std::string toString() const override;
112 
113   private:
114     /**
115      * Field-Replaceable Unit (FRU) for this action.
116      *
117      * The D-Bus inventory path of the FRU.
118      */
119     const std::string fru{};
120 
121     /**
122      * VPD keyword.
123      */
124     const std::string keyword{};
125 
126     /**
127      * Expected value.
128      */
129     const std::vector<uint8_t> value{};
130 };
131 
132 } // namespace phosphor::power::regulators
133