extensions/openpower-pels/host_notifier.hpp

19  * This class handles notifying the host firmware of new PELs.
24  * Some PELs do not need to be sent - see enqueueRequired() and
29  * 1) Send the ID and size of the new PEL to the host.
30  *   - The command response is asynchronous.
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
35  *    PLDM command to the PLDM daemon, who makes a D-Bus method
39  *    host is rebooted before the ack comes it will.
41  * The host firmware has a finite amount of space to store PELs before
44  * PLDM daemon to call  HostReject D-Bus method on this daemon instead
61      * @param[in] repo - The PEL repository object
62      * @param[in] dataIface - The data interface object
63      * @param[in] hostIface - The host interface object
78      * @return size_t - The queue size
87      *        set to the host.
90      *  - Already acked by the host (or they didn't like it)
91      *  - Hidden and the HMC already got it
92      *  - The 'do not report to host' bit is set
94      * @param[in] id - The PEL ID
96      * @return bool - If enqueue is required
98     bool enqueueRequired(uint32_t id) const;
101      * @brief If the host still needs to be notified of the PEL
105      *  - Already acked by the host
106      *  - It's hidden, and the HMC already got or will get it.
108      * @param[in] id - The PEL ID
110      * @return bool - If the notify is required
112     bool notifyRequired(uint32_t id) const;
115      * @brief Called when the host sends the 'ack' PLDM command.
119      * If the host was previously full, it is also an indication
122      * @param[in] id - The PEL ID
124     void ackPEL(uint32_t id);
127      * @brief Called when the host does not have room for more
135      * The PEL with this ID will need to be sent again, so its
145      * @param[in] id - The PEL ID
147     void setHostFull(uint32_t id);
150      * @brief Called when the host receives a malformed PEL.
157      * @param[in] id - The PEL ID
159     void setBadPEL(uint32_t id);
170      * @param[in] pel - The new PEL
178      * The deleted ID will be removed from the PEL queue and the
181      * @param[in] id - The deleted PEL ID
183     void deleteLogCallback(uint32_t id);
189      * @param[in] pel - The PEL
191      * @return bool - This is an indicator to the Repository::for_each
212      * @param[in] source - The event source object
217      * @brief Called when the host changes state.
219      * If the new state is host up and there are PELs to send, it
224      * @param[in] hostUp - The new host state
238      * @param[in] status - The response status
252      * @brief The function called when the 'host full' retry timer
255      * This will re-issue a command to try again with the PEL at
261      * @brief The function called when the host up retry timer
286      * @brief Base class pointer for the host command interface
303      * @brief The ID the PEL where the notification has
315      * @brief Indicates if the host has said it is full and does not
326      * @brief The host full timer, used to retry sending a PEL if the host
332      * @brief The host up timer, used to kick off sending commands to the
333      *        host after a delay after the host is up.