xref: /openbmc/phosphor-debug-collector/host-transport-extensions/pldm/oem/ibm/pldm_oem_cmds.hpp (revision 4c63ce5e2e507a0642e25d3e769ee8cb8638fbfe)
1 #pragma once
2 
3 #include <libpldm/pldm.h>
4 
5 namespace phosphor
6 {
7 namespace dump
8 {
9 namespace host
10 {
11 /**
12  * @brief Initiate offload of the dump with provided id
13  *
14  * @param[in] id - The Dump Source ID.
15  *
16  */
17 void requestOffload(uint32_t id);
18 
19 /**
20  * @brief Request to delete dump
21  *
22  * @param[in] id - The Dump Source ID.
23  * @param[in] dumpType - Type of the dump.
24  * @return NULL
25  *
26  */
27 void requestDelete(uint32_t id, uint32_t dumpType);
28 } // namespace host
29 
30 namespace pldm
31 {
32 
33 /**
34  * PLDMInterface
35  *
36  * Handles sending the SetNumericEffecterValue PLDM
37  * command to the host to start dump offload.
38  *
39  */
40 
41 /**
42  * @brief Kicks of the SetNumericEffecterValue command to
43  *        start offload the dump
44  *
45  * @param[in] id - The Dump Source ID.
46  *
47  */
48 
49 void requestOffload(uint32_t id);
50 
51 /**
52  * @brief Reads the MCTP endpoint ID out of a file
53  */
54 mctp_eid_t readEID();
55 
56 /**
57  * @brief Request to delete dump
58  *
59  * @param[in] id - The Dump Source ID.
60  * @param[in] dumpType - Type of the dump.
61  * @return NULL
62  *
63  */
64 void requestDelete(uint32_t id, uint32_t dumpType);
65 } // namespace pldm
66 } // namespace dump
67 } // namespace phosphor
68