1 /*
2  * Percepio DFM v2.1.0
3  * Copyright 2023 Percepio AB
4  * www.percepio.com
5  *
6  * SPDX-License-Identifier: Apache-2.0
7  */
8 
9 /**
10  * @file
11  *
12  * @brief DFM dummy Cloud port API
13  */
14 
15 #ifndef DFM_CLOUD_PORT_H
16 #define DFM_CLOUD_PORT_H
17 
18 #include <stdint.h>
19 #include <dfmTypes.h>
20 #include <dfm.h>
21 
22 #if ((DFM_CFG_ENABLED) >= 1)
23 
24 #ifdef __cplusplus
25 extern "C" {
26 #endif
27 
28 /**
29  * @defgroup dfm_cloud_port_dummy_apis DFM Dummy Cloud port API
30  * @ingroup dfm_apis
31  * @{
32  */
33 
34 /**
35  * @brief Cloud port system data
36  */
37 typedef struct DfmCloudPortData
38 {
39 	uint32_t dummy;
40 } DfmCloudPortData_t;
41 
42 /**
43  * @brief Initialize Cloud port system
44  *
45  * @param[in] pxBuffer Cloud port system buffer.
46  *
47  * @retval DFM_FAIL Failure
48  * @retval DFM_SUCCESS Success
49  */
50 DfmResult_t xDfmCloudPortInitialize(DfmCloudPortData_t* pxBuffer);
51 
52 /**
53  * @brief Send Alert Entry
54  *
55  * @param[in] xEntryHandle Entry handle.
56  *
57  * @retval DFM_FAIL Failure
58  * @retval DFM_SUCCESS Success
59  */
60 DfmResult_t xDfmCloudPortSendAlert(DfmEntryHandle_t xEntryHandle);
61 
62 /**
63  * @brief Send Payload chunk Entry
64  *
65  * @param[in] xEntryHandle Entry handle.
66  *
67  * @retval DFM_FAIL Failure
68  * @retval DFM_SUCCESS Success
69  */
70 DfmResult_t xDfmCloudPortSendPayloadChunk(DfmEntryHandle_t xEntryHandle);
71 
72 /** @} */
73 
74 #ifdef __cplusplus
75 }
76 #endif
77 
78 #endif
79 
80 #endif
81