blob: 57a3528db279fd088e5fca3d48d73e0f04ddc0bd [file] [log] [blame]
Deepak Kodihallie08fcad2016-11-22 02:10:08 -06001#pragma once
2
SunnySrivastava198419be6d32020-03-03 07:21:45 -06003#include "const.hpp"
Deepak Kodihallie08fcad2016-11-22 02:10:08 -06004#include "store.hpp"
5
Patrick Venturec83c4dc2018-11-01 16:29:18 -07006#include <cstddef>
girik18bb9852022-11-16 05:48:13 -06007#include <fstream>
Patrick Venturec83c4dc2018-11-01 16:29:18 -07008
Deepak Kodihallie08fcad2016-11-22 02:10:08 -06009namespace openpower
10{
11namespace vpd
12{
13namespace parser
14{
Deepak Kodihalli4a475bd2016-11-24 07:08:20 -060015namespace keyword
16{
Deepak Kodihalli4a475bd2016-11-24 07:08:20 -060017/** @brief Encoding scheme of a VPD keyword's data */
18enum class Encoding
19{
20 ASCII, /**< data encoded in ascii */
21 RAW, /**< raw data */
22 // Keywords needing custom decoding
Patrick Venturec83c4dc2018-11-01 16:29:18 -070023 B1, /**< The keyword B1 needs to be decoded specially */
George Liuee79ca82019-07-12 11:05:33 +080024 MB, /**< Special decoding of MB meant for Build Date */
Patrick Venturec83c4dc2018-11-01 16:29:18 -070025 UD /**< Special decoding of UD meant for UUID */
Deepak Kodihalli4a475bd2016-11-24 07:08:20 -060026};
27
28} // namespace keyword
Deepak Kodihallie08fcad2016-11-22 02:10:08 -060029
Deepak Kodihalli023112f2016-11-22 22:02:14 -060030namespace internal
31{
32
Deepak Kodihalli4a475bd2016-11-24 07:08:20 -060033using KeywordInfo = std::tuple<record::Keyword, keyword::Encoding>;
Deepak Kodihalli023112f2016-11-22 22:02:14 -060034using OffsetList = std::vector<uint32_t>;
Deepak Kodihalli683bf722016-11-24 06:50:43 -060035using KeywordMap = Parsed::mapped_type;
Deepak Kodihalli023112f2016-11-22 22:02:14 -060036
Patrick Venturec83c4dc2018-11-01 16:29:18 -070037} // namespace internal
Deepak Kodihalli023112f2016-11-22 22:02:14 -060038
Deepak Kodihallie08fcad2016-11-22 02:10:08 -060039/** @class Impl
Alpana Kumari26a74af2019-09-10 23:53:58 -050040 * @brief Implements parser for VPD
Deepak Kodihallie08fcad2016-11-22 02:10:08 -060041 *
Alpana Kumari26a74af2019-09-10 23:53:58 -050042 * An Impl object must be constructed by passing in VPD in
Deepak Kodihallie08fcad2016-11-22 02:10:08 -060043 * binary format. To parse the VPD, call the run() method. The run()
44 * method returns an openpower::vpd::Store object, which contains
45 * parsed VPD, and provides access methods for the VPD.
46 *
Alpana Kumari26a74af2019-09-10 23:53:58 -050047 * Following is the algorithm used to parse IPZ/OpenPower VPD:
Deepak Kodihallie08fcad2016-11-22 02:10:08 -060048 * 1) Validate that the first record is VHDR, the header record.
49 * 2) From the VHDR record, get the offset of the VTOC record,
50 * which is the table of contents record.
51 * 3) Process the VTOC record - note offsets of supported records.
52 * 4) For each supported record :
53 * 4.1) Jump to record via offset. Add record name to parser output.
54 * 4.2) Process record - for each contained and supported keyword:
55 * 4.2.1) Note keyword name and value, associate this information to
56 * to the record noted in step 4.1).
57 */
58class Impl
59{
Patrick Venturec83c4dc2018-11-01 16:29:18 -070060 public:
61 Impl() = delete;
62 Impl(const Impl&) = delete;
63 Impl& operator=(const Impl&) = delete;
64 Impl(Impl&&) = delete;
65 Impl& operator=(Impl&&) = delete;
66 ~Impl() = default;
Deepak Kodihallie08fcad2016-11-22 02:10:08 -060067
Patrick Venturec83c4dc2018-11-01 16:29:18 -070068 /** @brief Construct an Impl
69 *
Alpana Kumari26a74af2019-09-10 23:53:58 -050070 * @param[in] vpdBuffer - Binary VPD
Sunny Srivastavaf31a91b2022-06-09 08:11:29 -050071 * @param[in] path - To call out FRU in case of any PEL.
girik18bb9852022-11-16 05:48:13 -060072 * @param[in] vpdFilePath - VPD File Path
73 * @param[in] vpdStartOffset - Start offset of VPD.
Patrick Venturec83c4dc2018-11-01 16:29:18 -070074 */
girik18bb9852022-11-16 05:48:13 -060075 Impl(const Binary& vpdBuffer, const std::string& path,
76 const std::string& vpdFilePath, uint32_t vpdStartOffset) :
77 vpd(vpdBuffer),
78 inventoryPath(path), vpdFilePath(vpdFilePath),
79 vpdStartOffset(vpdStartOffset), out{}
Patrick Venturec83c4dc2018-11-01 16:29:18 -070080 {
girik18bb9852022-11-16 05:48:13 -060081 try
82 {
83 vpdFileStream.open(vpdFilePath,
84 std::ios::in | std::ios::out | std::ios::binary);
85 }
86 catch (const std::fstream::failure& e)
87 {
88 std::cout << e.what();
89 }
Patrick Venturec83c4dc2018-11-01 16:29:18 -070090 }
Deepak Kodihallie08fcad2016-11-22 02:10:08 -060091
Alpana Kumari26a74af2019-09-10 23:53:58 -050092 /** @brief Run the parser on binary VPD
Patrick Venturec83c4dc2018-11-01 16:29:18 -070093 *
94 * @returns openpower::vpd::Store object
95 */
96 Store run();
Deepak Kodihallie08fcad2016-11-22 02:10:08 -060097
SunnySrivastava1984f6d541e2020-02-04 12:50:40 -060098 /** @brief check if VPD header is valid
Patrick Venturec83c4dc2018-11-01 16:29:18 -070099 */
SunnySrivastava1984f6d541e2020-02-04 12:50:40 -0600100 void checkVPDHeader();
101
Priyanga Ramasamy28079c82021-10-07 16:30:51 -0500102 /** @brief Read a specific VPD keyword from hardware.
103 * This api is to read a specific VPD keyword directly from hardware.
104 * @param[in] record - record name.
105 * @param[in] keyword - keyword name.
106 * @return keyword value.
107 */
108 std::string readKwFromHw(const std::string& record,
109 const std::string& keyword);
110
SunnySrivastava1984f6d541e2020-02-04 12:50:40 -0600111 private:
112 /** @brief Process the table of contents record
113 *
114 * @param[in] iterator - iterator to buffer containing VPD
115 * @returns Size of the PT keyword in VTOC
116 */
girik18bb9852022-11-16 05:48:13 -0600117 std::size_t readTOC(Binary::const_iterator& iterator);
Deepak Kodihalli023112f2016-11-22 22:02:14 -0600118
Patrick Venturec83c4dc2018-11-01 16:29:18 -0700119 /** @brief Read the PT keyword contained in the VHDR record,
120 * to obtain offsets to other records in the VPD.
121 *
122 * @param[in] iterator - iterator to buffer containing VPD
123 * @param[in] ptLength - Length of PT keyword data
124 *
125 * @returns List of offsets to records in VPD
126 */
127 internal::OffsetList readPT(Binary::const_iterator iterator,
girik18bb9852022-11-16 05:48:13 -0600128 std::size_t ptLen);
Deepak Kodihalli023112f2016-11-22 22:02:14 -0600129
Patrick Venturec83c4dc2018-11-01 16:29:18 -0700130 /** @brief Read VPD information contained within a record
131 *
132 * @param[in] recordOffset - offset to a record location
Alpana Kumari26a74af2019-09-10 23:53:58 -0500133 * within the binary VPD
Patrick Venturec83c4dc2018-11-01 16:29:18 -0700134 */
135 void processRecord(std::size_t recordOffset);
Deepak Kodihallia1143462016-11-24 06:28:45 -0600136
Patrick Venturec83c4dc2018-11-01 16:29:18 -0700137 /** @brief Read keyword data
138 *
Alpana Kumari26a74af2019-09-10 23:53:58 -0500139 * @param[in] keyword - VPD keyword
Patrick Venturec83c4dc2018-11-01 16:29:18 -0700140 * @param[in] dataLength - Length of data to be read
141 * @param[in] iterator - iterator pointing to a Keyword's data in
142 * the VPD
143 *
144 * @returns keyword data as a string
145 */
146 std::string readKwData(const internal::KeywordInfo& keyword,
147 std::size_t dataLength,
148 Binary::const_iterator iterator);
Deepak Kodihallia1143462016-11-24 06:28:45 -0600149
Patrick Venturec83c4dc2018-11-01 16:29:18 -0700150 /** @brief While we're pointing at the keyword section of
151 * a record in the VPD, this will read all contained
152 * keywords and their values.
153 *
154 * @param[in] iterator - iterator pointing to a Keyword in the VPD
155 *
156 * @returns map of keyword:data
157 */
158 internal::KeywordMap readKeywords(Binary::const_iterator iterator);
Deepak Kodihalli683bf722016-11-24 06:50:43 -0600159
Patrick Venturec83c4dc2018-11-01 16:29:18 -0700160 /** @brief Checks if the VHDR record is present in the VPD */
girik18bb9852022-11-16 05:48:13 -0600161 void checkHeader();
Deepak Kodihalli810c9de2016-11-22 11:42:51 -0600162
Alpana Kumaric0aeac32019-11-28 05:20:10 -0600163 /** @brief Checks the ECC for VHDR Record.
164 * @returns Success(0) OR corrupted data(-1)
165 */
girik18bb9852022-11-16 05:48:13 -0600166 int vhdrEccCheck();
Alpana Kumaric0aeac32019-11-28 05:20:10 -0600167
168 /** @brief Checks the ECC for VTOC Record.
169 * @returns Success(0) OR corrupted data(-1)
170 */
girik18bb9852022-11-16 05:48:13 -0600171 int vtocEccCheck();
Alpana Kumaric0aeac32019-11-28 05:20:10 -0600172
173 /** @brief Checks the ECC for the given record.
174 *
175 * @param[in] iterator - iterator pointing to a record in the VPD
176 * @returns Success(0) OR corrupted data(-1)
177 */
girik18bb9852022-11-16 05:48:13 -0600178 int recordEccCheck(Binary::const_iterator iterator);
Alpana Kumaric0aeac32019-11-28 05:20:10 -0600179
180 /** @brief This interface collects Offset of VTOC
181 * @returns VTOC Offset
182 */
SunnySrivastava198419be6d32020-03-03 07:21:45 -0600183 openpower::vpd::constants::RecordOffset getVtocOffset() const;
Alpana Kumaric0aeac32019-11-28 05:20:10 -0600184
Alpana Kumari26a74af2019-09-10 23:53:58 -0500185 /** @brief VPD in binary format */
PriyangaRamasamy33c61c22021-04-06 11:15:57 -0500186 const Binary& vpd;
Deepak Kodihallie08fcad2016-11-22 02:10:08 -0600187
Sunny Srivastavaf31a91b2022-06-09 08:11:29 -0500188 /** Inventory path to call out FRU if required */
189 const std::string inventoryPath;
190
girik18bb9852022-11-16 05:48:13 -0600191 /** Eeprom hardware path */
192 inventory::Path vpdFilePath;
193
194 /** VPD Offset **/
195 uint32_t vpdStartOffset;
196
197 /** File stream for VPD */
198 std::fstream vpdFileStream;
199
Patrick Venturec83c4dc2018-11-01 16:29:18 -0700200 /** @brief parser output */
201 Parsed out;
Deepak Kodihallie08fcad2016-11-22 02:10:08 -0600202};
203
204} // namespace parser
205} // namespace vpd
Patrick Williamsc78d8872023-05-10 07:50:56 -0500206} // namespace openpower