1386a61e6SMatt Spinler /**
2386a61e6SMatt Spinler * Copyright © 2020 IBM Corporation
3386a61e6SMatt Spinler *
4386a61e6SMatt Spinler * Licensed under the Apache License, Version 2.0 (the "License");
5386a61e6SMatt Spinler * you may not use this file except in compliance with the License.
6386a61e6SMatt Spinler * You may obtain a copy of the License at
7386a61e6SMatt Spinler *
8386a61e6SMatt Spinler * http://www.apache.org/licenses/LICENSE-2.0
9386a61e6SMatt Spinler *
10386a61e6SMatt Spinler * Unless required by applicable law or agreed to in writing, software
11386a61e6SMatt Spinler * distributed under the License is distributed on an "AS IS" BASIS,
12386a61e6SMatt Spinler * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13386a61e6SMatt Spinler * See the License for the specific language governing permissions and
14386a61e6SMatt Spinler * limitations under the License.
15386a61e6SMatt Spinler */
16386a61e6SMatt Spinler #include "extended_user_data.hpp"
17386a61e6SMatt Spinler
18386a61e6SMatt Spinler #include "pel_types.hpp"
19386a61e6SMatt Spinler #ifdef PELTOOL
20386a61e6SMatt Spinler #include "user_data_json.hpp"
21386a61e6SMatt Spinler #endif
225bc26533SArya K Padman #include <phosphor-logging/lg2.hpp>
237f1b9052SMatt Spinler
241aa90d49SJayanth Othayoth #include <format>
251aa90d49SJayanth Othayoth
26386a61e6SMatt Spinler namespace openpower::pels
27386a61e6SMatt Spinler {
28386a61e6SMatt Spinler
unflatten(Stream & stream)29386a61e6SMatt Spinler void ExtendedUserData::unflatten(Stream& stream)
30386a61e6SMatt Spinler {
31386a61e6SMatt Spinler stream >> _header;
32386a61e6SMatt Spinler
33386a61e6SMatt Spinler if (_header.size <= SectionHeader::flattenedSize() + 4)
34386a61e6SMatt Spinler {
35386a61e6SMatt Spinler throw std::out_of_range(
361aa90d49SJayanth Othayoth std::format("ExtendedUserData::unflatten: SectionHeader::size {} "
37386a61e6SMatt Spinler "too small",
38386a61e6SMatt Spinler _header.size));
39386a61e6SMatt Spinler }
40386a61e6SMatt Spinler
41386a61e6SMatt Spinler size_t dataLength = _header.size - 4 - SectionHeader::flattenedSize();
42386a61e6SMatt Spinler _data.resize(dataLength);
43386a61e6SMatt Spinler
44386a61e6SMatt Spinler stream >> _creatorID >> _reserved1B >> _reserved2B >> _data;
45386a61e6SMatt Spinler }
46386a61e6SMatt Spinler
flatten(Stream & stream) const47386a61e6SMatt Spinler void ExtendedUserData::flatten(Stream& stream) const
48386a61e6SMatt Spinler {
49386a61e6SMatt Spinler stream << _header << _creatorID << _reserved1B << _reserved2B << _data;
50386a61e6SMatt Spinler }
51386a61e6SMatt Spinler
ExtendedUserData(Stream & pel)52386a61e6SMatt Spinler ExtendedUserData::ExtendedUserData(Stream& pel)
53386a61e6SMatt Spinler {
54386a61e6SMatt Spinler try
55386a61e6SMatt Spinler {
56386a61e6SMatt Spinler unflatten(pel);
57386a61e6SMatt Spinler validate();
58386a61e6SMatt Spinler }
59386a61e6SMatt Spinler catch (const std::exception& e)
60386a61e6SMatt Spinler {
615bc26533SArya K Padman lg2::error("Cannot unflatten ExtendedUserData section: {EXCEPTION}",
625bc26533SArya K Padman "EXCEPTION", e);
63386a61e6SMatt Spinler _valid = false;
64386a61e6SMatt Spinler }
65386a61e6SMatt Spinler }
66386a61e6SMatt Spinler
ExtendedUserData(uint16_t componentID,uint8_t subType,uint8_t version,uint8_t creatorID,const std::vector<uint8_t> & data)67386a61e6SMatt Spinler ExtendedUserData::ExtendedUserData(uint16_t componentID, uint8_t subType,
68386a61e6SMatt Spinler uint8_t version, uint8_t creatorID,
69386a61e6SMatt Spinler const std::vector<uint8_t>& data)
70386a61e6SMatt Spinler {
71386a61e6SMatt Spinler _header.id = static_cast<uint16_t>(SectionID::extUserData);
72386a61e6SMatt Spinler _header.version = version;
73386a61e6SMatt Spinler _header.subType = subType;
74386a61e6SMatt Spinler _header.componentID = componentID;
75386a61e6SMatt Spinler
76386a61e6SMatt Spinler _creatorID = creatorID;
77386a61e6SMatt Spinler _reserved1B = 0;
78386a61e6SMatt Spinler _reserved2B = 0;
79386a61e6SMatt Spinler _data = data;
80386a61e6SMatt Spinler _header.size = flattenedSize();
81386a61e6SMatt Spinler _valid = true;
82386a61e6SMatt Spinler }
83386a61e6SMatt Spinler
validate()84386a61e6SMatt Spinler void ExtendedUserData::validate()
85386a61e6SMatt Spinler {
86386a61e6SMatt Spinler if (header().id != static_cast<uint16_t>(SectionID::extUserData))
87386a61e6SMatt Spinler {
885bc26533SArya K Padman lg2::error("Invalid ExtendedUserData section ID: {HEADER_ID}",
895bc26533SArya K Padman "HEADER_ID", lg2::hex, header().id);
90386a61e6SMatt Spinler _valid = false;
91386a61e6SMatt Spinler }
92386a61e6SMatt Spinler else
93386a61e6SMatt Spinler {
94386a61e6SMatt Spinler _valid = true;
95386a61e6SMatt Spinler }
96386a61e6SMatt Spinler }
97386a61e6SMatt Spinler
getJSON(uint8_t,const std::vector<std::string> & plugins) const98*075c7923SPatrick Williams std::optional<std::string> ExtendedUserData::getJSON(
99*075c7923SPatrick Williams uint8_t /*creatorID*/,
100*075c7923SPatrick Williams const std::vector<std::string>& plugins [[maybe_unused]]) const
101386a61e6SMatt Spinler {
102386a61e6SMatt Spinler // Use the creator ID value from the section.
103386a61e6SMatt Spinler #ifdef PELTOOL
104386a61e6SMatt Spinler return user_data::getJSON(_header.componentID, _header.subType,
105386a61e6SMatt Spinler _header.version, _data, _creatorID, plugins);
106386a61e6SMatt Spinler #endif
107386a61e6SMatt Spinler return std::nullopt;
108386a61e6SMatt Spinler }
109386a61e6SMatt Spinler
shrink(size_t newSize)110386a61e6SMatt Spinler bool ExtendedUserData::shrink(size_t newSize)
111386a61e6SMatt Spinler {
112386a61e6SMatt Spinler // minimum size is 8B header + 4B of fields + 4B of data
113386a61e6SMatt Spinler if ((newSize < flattenedSize()) &&
114386a61e6SMatt Spinler (newSize >= (Section::flattenedSize() + 8)))
115386a61e6SMatt Spinler {
116386a61e6SMatt Spinler auto dataSize = newSize - Section::flattenedSize() - 4;
117386a61e6SMatt Spinler
118386a61e6SMatt Spinler // Ensure it's 4B aligned
119386a61e6SMatt Spinler _data.resize((dataSize / 4) * 4);
120386a61e6SMatt Spinler _header.size = flattenedSize();
121386a61e6SMatt Spinler return true;
122386a61e6SMatt Spinler }
123386a61e6SMatt Spinler
124386a61e6SMatt Spinler return false;
125386a61e6SMatt Spinler }
126386a61e6SMatt Spinler
127386a61e6SMatt Spinler } // namespace openpower::pels
128