openbmc/phosphor-net-ipmid/message_parsers.hpp

3 #include "message.hpp"
8 namespace message  namespace
17 // Number of FFh to indicate that an RMCP ACK message should not be
18 // generated by the message receiver.
21 // RMCP Message Class 7h is for IPMI
27 // RMCP/ASF Pong Message ASF Header Data Length
75  * @brief Unflatten an incoming packet and prepare the IPMI message
79  * @return A tuple with IPMI message and the session header type to sent the
80  *         response packet. In case of success incoming message and session
84 std::tuple<std::shared_ptr<Message>, SessionHeader> unflatten(
88  * @brief Flatten an IPMI message and generate the IPMI packet with the
91  * @param[in] outMessage - IPMI message to be flattened
97 std::vector<uint8_t> flatten(const std::shared_ptr<Message>& outMessage,
121  * @brief Unflatten an incoming packet and prepare the IPMI message
125  * @return IPMI message in the packet on success
127 std::shared_ptr<Message> unflatten(std::vector<uint8_t>& inPacket);
130  * @brief Flatten an IPMI message and generate the IPMI packet with the
133  * @param[in] outMessage - IPMI message to be flattened
137 std::vector<uint8_t> flatten(const std::shared_ptr<Message>& outMessage,
168  * @brief Unflatten an incoming packet and prepare the IPMI message
172  * @return IPMI message in the packet on success
174 std::shared_ptr<Message> unflatten(std::vector<uint8_t>& inPacket);
177  * @brief Flatten an IPMI message and generate the IPMI packet with the
180  * @param[in] outMessage - IPMI message to be flattened
185 std::vector<uint8_t> flatten(const std::shared_ptr<Message>& outMessage,
192  * @brief Add sequence number to the message
205  * @param[in] message - IPMI Message populated from the incoming packet
211                            const std::shared_ptr<Message>& message,
219  * @param[in] message - IPMI Message populated for the outgoing packet
223                       const std::shared_ptr<Message>& message,
231  * @param[in] message - IPMI Message populated from the incoming packet
238     const std::vector<uint8_t>& packet, const std::shared_ptr<Message>& message,
244  * @param[in] message - IPMI Message populated for the outgoing packet
250     const std::shared_ptr<Message>& message,
261 // ASF message fields for RMCP Ping message
273 // ASF message fields for RMCP Pong message
287  * @brief Unflatten an incoming packet and prepare the ASF message
291  * @return ASF message in the packet on success
293 std::shared_ptr<Message> unflatten(std::vector<uint8_t>& inPacket);
298  * @param[in] asfMsgTag - ASF Message Tag from Ping request
307 } // namespace message