DJI Payload SDK  1.5.3
psdk_osdk_func.h
Go to the documentation of this file.
1 /**
2  ******************************************************************************
3  * @file psdk_osdk_func.h
4  * @version V1.4.0
5  * @date 2018/11/20
6  * @brief
7  * This is the header file for "psdk_osdk_func.c", defining the structure and
8  * (exported) function prototypes.
9  *
10  * @copyright (c) 2017-2018 DJI. All rights reserved.
11  *
12  * All information contained herein is, and remains, the property of DJI.
13  * The intellectual and technical concepts contained herein are proprietary
14  * to DJI and may be covered by U.S. and foreign patents, patents in process,
15  * and protected by trade secret or copyright law. Dissemination of this
16  * information, including but not limited to data and other proprietary
17  * material(s) incorporated within the information, in any form, is strictly
18  * prohibited without the express written consent of DJI.
19  *
20  * If you receive this source code without DJI’s authorization, you may not
21  * further disseminate the information, and you must immediately remove the
22  * source code and notify DJI of its removal. DJI reserves the right to pursue
23  * legal actions against you for any loss(es) or damage(s) caused by your
24  * failure to do so.
25  *
26  ******************************************************************************
27  */
28 
29 /* Define to prevent recursive inclusion -------------------------------------*/
30 #ifndef PSDK_OSDK_FUNC_H
31 #define PSDK_OSDK_FUNC_H
32 
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36 
37 /* Includes ------------------------------------------------------------------*/
38 #include "psdk_upper.h"
39 #include "psdk_cmdset.h"
40 
41 /** @addtogroup PSDK
42  * @{
43  */
44 
45 /** @addtogroup PSDK_Osdk_Function
46  * @{
47  */
48 
49 /* Exported constants --------------------------------------------------------*/
50 /* Exported macros -----------------------------------------------------------*/
51 /* Exported types ------------------------------------------------------------*/
52 
53 /** @defgroup O_Func_Exported_Types Exported Types
54  * @{
55  */
56 
57 /** @defgroup O_Func_Callback_Related Callback Related
58  * @{
59  */
60 
61 /**
62  * @brief OSDK related function list and configure parameters.
63  * @details This structure type is used to define a list structure that includes all
64  * the callback functions and parameters that you can design for OSDK data transmission:
65  * 1. Transparent data transmission from OSDK to payload end
66  */
67 typedef struct {
68  void (*ReceiveFromOsdkCallback) (const uint8_t *pData, uint16_t dataLen); /*!< Receive data from OSDK callback function. */
70 
71 /**
72  * @}
73  */
74 
75 /**
76  * @}
77  */
78 
79 /* Exported variables --------------------------------------------------------*/
80 /* Exported functions --------------------------------------------------------*/
81 
82 /** @defgroup O_Func_Exported_Functions Exported Functions
83  * @{
84  */
85 
86 E_PsdkStat PsdkOsdkFunc_Init(T_PsdkUpper *psdkUpper, const T_PsdkOsdkFuncHandler *osdkFuncHandler);
87 E_PsdkStat PsdkOsdkFunc_TransferToOsdk(T_PsdkUpper *psdkUpper, const uint8_t *pSendData, uint16_t needSendLen, uint16_t *pRealSendLen);
88 
89 /**
90  * @}
91  */
92 
93 /* Private constants ---------------------------------------------------------*/
94 /* Private macros ------------------------------------------------------------*/
95 /* Private types -------------------------------------------------------------*/
96 /* Private variables ---------------------------------------------------------*/
97 /* Private functions ---------------------------------------------------------*/
98 
99 /**
100  * @}
101  */
102 
103 /**
104  * @}
105  */
106 
107 #ifdef __cplusplus
108 }
109 #endif
110 
111 #endif //PSDK_OSDK_FUNC_H
112 
113 /****************** (C) COPYRIGHT DJI Innovations *****END OF FILE****/
This is a structure type for defining a top-level structure for the integration of your application w...
Definition: psdk_upper.h:113
OSDK related function list and configure parameters.
Definition: psdk_osdk_func.h:67
This is the header file for "psdk_upper.c", defining the structures and (exported) function prototype...
This file defines the PSDK command set.