extensions/openpower-pels/pel.hpp

47  * section and User Header section, which must be in the first and second
56  * - From a full formed flattened PEL.
57  * - From scratch based on an OpenBMC event and its corresponding PEL message
76      * Build a PEL from raw data.
83      * @param[in] data - The PEL data
90      * Build a PEL from the raw data.
92      * @param[in] data - the PEL data
93      * @param[in] obmcLogID - the corresponding OpenBMC event log ID
103      * @param[in] entry - The message registry entry for this error
104      * @param[in] obmcLogID - ID of corresponding OpenBMC event log
105      * @param[in] timestamp - Timestamp from the event log
106      * @param[in] severity - Severity from the event log
107      * @param[in] additionalData - The AdditionalData contents
108      * @param[in] ffdcFiles - FFCD files that go into UserData sections
109      * @param[in] dataIface - The data interface object
110      * @param[in] journal - The journal object
121      * @return uint32_t - the ID
125         return _ph->id();  in id()
132      * @return uint32_t - the PLID
136         return _ph->plid();  in plid()
143      * @return uint32_t - the OpenBMC event log ID
147         return _ph->obmcLogID();  in obmcLogID()
154      * @return BCDTime - the timestamp
158         return _ph->commitTimestamp();  in commitTime()
165      * @return BCDTime - the timestamp
169         return _ph->createTimestamp();  in createTime()
175      * @return const PrivateHeader& - the private header
183      * @brief Gives access to the User Header section class
185      * @return const UserHeader& - the user header
198      * @return std::optional<SRC*> - the SRC section object
204      *        the Private and User Headers.
216      * @return std::vector<uint8_t> - the raw PEL data
230      * @return bool - if the PEL is valid
246      * @param[in] registry - Registry object reference
247      * @param[in] plugins - Vector of strings of plugins found in filesystem
250                 const std::vector<std::string>& plugins) const;
253      * @brief Sets the host transmission state in the User Header
255      * @param[in] state - The state value
259         _uh->setHostTransmissionState(static_cast<uint8_t>(state));  in setHostTransmissionState()
265      * @return HostTransmissionState - The state
269         return static_cast<TransmissionState>(_uh->hostTransmissionState());  in hostTransmissionState()
273      * @brief Sets the HMC transmission state in the User Header
275      * @param[in] state - The state value
279         _uh->setHMCTransmissionState(static_cast<uint8_t>(state));  in setHMCTransmissionState()
285      * @return HMCTransmissionState - The state
289         return static_cast<TransmissionState>(_uh->hmcTransmissionState());  in hmcTransmissionState()
300      * @brief Updates the system info data into HB extended user
303      * @param[in] dataIface - The data interface object
315      * @return bool - If the 'one or more resources are deconfigured'
327      * @return bool - If the 'one or more resources are guarded'
339      * @param[in] data - The PEL data
340      * @param[in] obmcLogID - The OpenBMC event log ID to use for that
348      * @param[out] pelBuffer - What the data will be written to
370      * @param[in] userData - The section to add
372      * @return bool - If the section was added or not.
378      * @param[in] Section& - section object reference
379      * @param[in] std::string - PEL string
380      * @param[in|out] pluralSections - Map used to track sections counts for
382      * @param[in] registry - Registry object reference
383      * @param[in] plugins - Vector of strings of plugins found in filesystem
384      * @param[in] creatorID - Creator Subsystem ID (only for UserData section)
389         const std::vector<std::string>& plugins, uint8_t creatorID = 0) const;
395      * sub-type value set to 0xCA and returns its data as a JSON object.
397      * @param[in] ffdcFiles - FFCD files that go into UserData sections
399      * @return json - The callout JSON, or an empty object if not found
413      * @param regEntry - The registry entry
414      * @param journal - The journal object
423      * @param[in] src - Unique pointer to the SRC object
424      * @param[in] dataIface - The data interface object
425      * @param[out] adSysInfoData - The additional data to SysInfo in json format
426      * @param[out] debugData - The map of string and vector of string to store
439      * @brief The PEL User Header section
460  * @param[in] json - The JSON contents
462  * @return std::unique_ptr<UserData> - The UserData object
470  * @param[in] ad - The AdditionalData contents
472  * @return std::unique_ptr<UserData> - The section
480  * @param[in] ad - The AdditionalData contents
481  * @param[in] dataIface - The data interface object
482  * @param[in] addUptime - Whether to add the uptime attribute the default is
484  * @param[in] adSysInfoData - The additional data to SysInfo in json format.
487  * @return std::unique_ptr<UserData> - The section
498  * @param[in] fd - The FD to read from
500  * @return std::vector<uint8_t> - The data read
508  * @param[in] componentID - The component ID of the PEL creator
509  * @param[in] file - The FFDC file information
518  * @param[in] locationCode - The location code of the DIMM
519  * @param[in] diPropVal - The DI property value of the DIMM
520  * @param[out] adSysInfoData - Holds the created JSON object
533  * @param lines - The vector of strings to convert
535  * @return std::vector<uint8_t> - The flattened data