extensions/openpower-pels/host_notifier.hpp

4 #include "pel.hpp"
27  * The high level good path flow for sending a single PEL is:
29  * 1) Send the ID and size of the new PEL to the host.
32  * 2) The host reads the raw PEL data (outside of this class).
34  * 3) The host sends the PEL to the OS, and then sends an AckPEL
38  *    After this, a PEL never needs to be sent again, but if the
46  * PELs from being sent, and the first PEL that hits this will have
61      * @param[in] repo - The PEL repository object
74      * @brief Returns the PEL queue size.
86      * @brief Specifies if the PEL needs to go onto the queue to be
94      * @param[in] id - The PEL ID
101      * @brief If the host still needs to be notified of the PEL
108      * @param[in] id - The PEL ID
117      * This means the PEL never needs to be sent up again.
122      * @param[in] id - The PEL ID
135      * The PEL with this ID will need to be sent again, so its
145      * @param[in] id - The PEL ID
150      * @brief Called when the host receives a malformed PEL.
155      * The PEL should never be sent up again.
157      * @param[in] id - The PEL ID
164      *        when a new PEL is added to it.
166      * This function puts the PEL on the queue to be sent up if it
170      * @param[in] pel - The new PEL
172     void newLogCallback(const PEL& pel);
176      *        when a PEL is deleted.
178      * The deleted ID will be removed from the PEL queue and the
181      * @param[in] id - The deleted PEL ID
186      * @brief This function runs on every existing PEL at startup
187      *        and puts the PEL on the queue to send if necessary.
189      * @param[in] pel - The PEL
192      *                function to traverse every PEL.  Always false.
194     bool addPELToQueue(const PEL& pel);
197      * @brief Takes the first PEL from the queue that needs to be
232      * If the command was successful, the state of that PEL will
246      * It will issue a send of the previous PEL and increment the
255      * This will re-issue a command to try again with the PEL at
276      * @brief The PEL repository object
291      * @brief The list of PEL IDs that need to be sent.
303      * @brief The ID the PEL where the notification has
326      * @brief The host full timer, used to retry sending a PEL if the host
338      * @brief The object used to dispatch a new PEL send from the