1 /**
2  * Copyright © 2019 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 #include "failing_mtms.hpp"
17 
18 #include "json_utils.hpp"
19 #include "pel_types.hpp"
20 #include "pel_values.hpp"
21 
22 #include <phosphor-logging/lg2.hpp>
23 
24 #include <format>
25 
26 namespace openpower
27 {
28 namespace pels
29 {
30 
31 namespace pv = openpower::pels::pel_values;
32 
33 static constexpr uint8_t failingMTMSVersion = 0x01;
34 
FailingMTMS(const DataInterfaceBase & dataIface)35 FailingMTMS::FailingMTMS(const DataInterfaceBase& dataIface) :
36     _mtms(dataIface.getMachineTypeModel(), dataIface.getMachineSerialNumber())
37 {
38     _header.id = static_cast<uint16_t>(SectionID::failingMTMS);
39     _header.size = FailingMTMS::flattenedSize();
40     _header.version = failingMTMSVersion;
41     _header.subType = 0;
42     _header.componentID = static_cast<uint16_t>(ComponentID::phosphorLogging);
43 
44     _valid = true;
45 }
46 
FailingMTMS(Stream & pel)47 FailingMTMS::FailingMTMS(Stream& pel)
48 {
49     try
50     {
51         unflatten(pel);
52         validate();
53     }
54     catch (const std::exception& e)
55     {
56         lg2::error("Cannot unflatten failing MTM section: {EXCEPTION}",
57                    "EXCEPTION", e);
58         _valid = false;
59     }
60 }
61 
validate()62 void FailingMTMS::validate()
63 {
64     bool failed = false;
65 
66     if (header().id != static_cast<uint16_t>(SectionID::failingMTMS))
67     {
68         lg2::error("Invalid failing MTMS section ID: {HEADER_ID}", "HEADER_ID",
69                    lg2::hex, header().id);
70         failed = true;
71     }
72 
73     if (header().version != failingMTMSVersion)
74     {
75         lg2::error("Invalid failing MTMS version: {HEADER_VERSION}",
76                    "HEADER_VERSION", lg2::hex, header().version);
77         failed = true;
78     }
79 
80     _valid = (failed) ? false : true;
81 }
82 
flatten(Stream & stream) const83 void FailingMTMS::flatten(Stream& stream) const
84 {
85     stream << _header << _mtms;
86 }
87 
unflatten(Stream & stream)88 void FailingMTMS::unflatten(Stream& stream)
89 {
90     stream >> _header >> _mtms;
91 }
92 
getJSON(uint8_t creatorID) const93 std::optional<std::string> FailingMTMS::getJSON(uint8_t creatorID) const
94 {
95     std::string json;
96     jsonInsert(json, pv::sectionVer, getNumberString("%d", _header.version), 1);
97     jsonInsert(json, pv::subSection, getNumberString("%d", _header.subType), 1);
98     jsonInsert(json, pv::createdBy,
99                getComponentName(_header.componentID, creatorID), 1);
100     jsonInsert(json, "Machine Type Model", _mtms.machineTypeAndModel(), 1);
101     jsonInsert(json, "Serial Number", trimEnd(_mtms.machineSerialNumber()), 1);
102     json.erase(json.size() - 2);
103     return json;
104 }
105 } // namespace pels
106 } // namespace openpower
107