blob: b4b0d9dc09f6fecbc9befcfe32cae5d3f6ad64e1 [file] [log] [blame]
Jayanth Othayothd31be2c2020-02-04 02:56:45 -06001#pragma once
2
3#include <libpldm/pldm.h>
4
5namespace phosphor
6{
7namespace dump
8{
Ramesh Iyyar3af5c322020-12-04 00:38:42 -06009namespace host
10{
11/**
12 * @brief Initiate offload of the dump with provided id
13 *
14 * @param[in] id - The Dump Source ID.
15 *
16 */
17void requestOffload(uint32_t id);
Ramesh Iyyar22793862020-12-04 04:03:03 -060018
19/**
20 * @brief Request to delete dump
21 *
22 * @param[in] id - The Dump Source ID.
Dhruvaraj Subhashchandran4c63ce52020-12-18 02:07:22 -060023 * @param[in] dumpType - Type of the dump.
Ramesh Iyyar22793862020-12-04 04:03:03 -060024 * @return NULL
25 *
26 */
Dhruvaraj Subhashchandran4c63ce52020-12-18 02:07:22 -060027void requestDelete(uint32_t id, uint32_t dumpType);
Ramesh Iyyar3af5c322020-12-04 00:38:42 -060028} // namespace host
29
Jayanth Othayothd31be2c2020-02-04 02:56:45 -060030namespace 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
49void requestOffload(uint32_t id);
50
51/**
52 * @brief Reads the MCTP endpoint ID out of a file
53 */
54mctp_eid_t readEID();
55
Ramesh Iyyar22793862020-12-04 04:03:03 -060056/**
57 * @brief Request to delete dump
58 *
59 * @param[in] id - The Dump Source ID.
Dhruvaraj Subhashchandran4c63ce52020-12-18 02:07:22 -060060 * @param[in] dumpType - Type of the dump.
Ramesh Iyyar22793862020-12-04 04:03:03 -060061 * @return NULL
62 *
63 */
Dhruvaraj Subhashchandran4c63ce52020-12-18 02:07:22 -060064void requestDelete(uint32_t id, uint32_t dumpType);
Jayanth Othayothd31be2c2020-02-04 02:56:45 -060065} // namespace pldm
66} // namespace dump
67} // namespace phosphor