extensions/openpower-pels/pel.hpp

37 /** @class PEL
42  * Every field in a PEL are in structures call sections, of which there are
46  * The only two required sections for every type of PEL are the Private Header
56  * - From a full formed flattened PEL.
57  * - From scratch based on an OpenBMC event and its corresponding PEL message
60  * The data() method allows one to retrieve the PEL as a vector<uint8_t>.  This
63 class PEL  class
66     PEL() = delete;
67     ~PEL() = default;
68     PEL(const PEL&) = delete;
69     PEL& operator=(const PEL&) = delete;
70     PEL(PEL&&) = delete;
71     PEL& operator=(PEL&&) = delete;
76      * Build a PEL from raw data.
83      * @param[in] data - The PEL data
85     explicit PEL(std::vector<uint8_t>& data);
90      * Build a PEL from the raw data.
92      * @param[in] data - the PEL data
95     PEL(std::vector<uint8_t>& data, uint32_t obmcLogID);
100      * Creates a PEL from an OpenBMC event log and its message
112     PEL(const openpower::pels::message::Entry& entry, uint32_t obmcLogID,
214      * @brief Returns the PEL data.
216      * @return std::vector<uint8_t> - the raw PEL data
221      * @brief Returns the size of the PEL
223      * @return size_t The PEL size in bytes
228      * @brief Says if the PEL is valid (the sections are all valid)
230      * @return bool - if the PEL is valid
245      * @brief Output a PEL in JSON.
301      *        data section to this PEL object
334      * @brief Builds the section objects from a PEL data buffer
339      * @param[in] data - The PEL data
346      * @brief Flattens the PEL objects into the buffer
353      * @brief Check that the PEL fields that need to be in agreement
360      *        in the PEL.  The data value for each entry will be set to 0.
367      * @brief Adds the UserData section to this PEL object,
379      * @param[in] std::string - PEL string
404      * @brief Update terminate bit in primary SRC section to this PEL object is
410      * @brief Adds journal data to the PEL as UserData sections
421      * the PEL as a JSON object in adSysInfoData.
434      * @brief The PEL Private Header section
439      * @brief The PEL User Header section
449      * @brief The maximum size a PEL can be in bytes.
508  * @param[in] componentID - The component ID of the PEL creator
529  *        for storing in a PEL section.