DJI Payload SDK  1.5.3
psdk_cmdset_osdk_func.h
Go to the documentation of this file.
1 /**
2  ******************************************************************************
3  * @file psdk_cmdset_osdk_func.h
4  * @version V1.4.0
5  * @date 2018/11/20
6  * @brief This file defines the OSDK function command set.
7  *
8  * @copyright (c) 2017-2018 DJI. All rights reserved.
9  *
10  * All information contained herein is, and remains, the property of DJI.
11  * The intellectual and technical concepts contained herein are proprietary
12  * to DJI and may be covered by U.S. and foreign patents, patents in process,
13  * and protected by trade secret or copyright law. Dissemination of this
14  * information, including but not limited to data and other proprietary
15  * material(s) incorporated within the information, in any form, is strictly
16  * prohibited without the express written consent of DJI.
17  *
18  * If you receive this source code without DJI’s authorization, you may not
19  * further disseminate the information, and you must immediately remove the
20  * source code and notify DJI of its removal. DJI reserves the right to pursue
21  * legal actions against you for any loss(es) or damage(s) caused by your
22  * failure to do so.
23  *
24  ******************************************************************************
25  */
26 
27 /* Define to prevent recursive inclusion -------------------------------------*/
28 #ifndef PSDK_CMDSET_OSDK_FUNC_H
29 #define PSDK_CMDSET_OSDK_FUNC_H
30 
31 #ifdef __cplusplus
32 extern "C" {
33 #endif
34 
35 /* Includes ------------------------------------------------------------------*/
36 #include <psdk_typedef.h>
37 #include <psdk_core.h>
38 
39 /** @addtogroup PSDK
40  * @{
41  */
42 
43 /** @addtogroup PSDK_Osdk_Function
44  * @{
45  */
46 
47 /* Exported constants --------------------------------------------------------*/
48 
49 /** @defgroup O_Func_Exported_Constants Exported constants
50  * @{
51  */
52 
53 #define OSDKFUNC_OSDK_TO_PSDK_MAX_LEN 255 /*!< Max size of data from OSDK to payload end */
54 #define OSDKFUNC_PSDK_TO_OSDK_MAX_LEN 255 /*!< Max size of data from payload end to OSDK */
55 
56 /**
57  * @}
58  */
59 
60 /* Exported macros -----------------------------------------------------------*/
61 /* Exported types ------------------------------------------------------------*/
62 
63 /** @defgroup O_Func_Exported_Types Exported Types
64  * @{
65  */
66 
67 /** @defgroup O_Func_Command_Related Command Related
68  * @{
69  */
70 
71 /**
72  * @brief OSDK Function Command ID
73  */
74 typedef enum {
75  PSDK_OSDKFUNC_CMDID_TT_OSDK_TO_PSDK = 0x01, /*!< Transparent data transmission from OSDK to payload end */
76  PSDK_OSDKFUNC_CMDID_TT_PSDK_TO_OSDK = 0x02, /*!< Transparent data transmission from payload end to OSDK */
78 
79 #pragma pack(1)
80 
81 /**
82  * @brief Transparent data transmission from OSDK to payload end command request data structure.
83  */
84 typedef struct {
85  uint8_t data[OSDKFUNC_OSDK_TO_PSDK_MAX_LEN]; /*!< Specifies transmission data. */
87 
88 /**
89  * @brief Transparent data transmission from OSDK to payload end command ack data structure.
90  */
91 typedef struct {
92  PSDK_EMPTY_STRUCT
94 
95 /**
96  * @brief Transparent data transmission from payload end to OSDK command request data structure.
97  */
98 typedef struct {
99  uint8_t data[OSDKFUNC_PSDK_TO_OSDK_MAX_LEN]; /*!< Specifies transmission data. */
101 
102 /**
103  * @brief Transparent data transmission from payload end to OSDK command ack data structure.
104  */
105 typedef struct {
106  PSDK_EMPTY_STRUCT
108 
109 #pragma pack()
110 
111 /**
112  * @}
113  */
114 
115 /**
116  * @}
117  */
118 
119 /* Exported variables --------------------------------------------------------*/
120 /* Exported functions --------------------------------------------------------*/
121 /* Private constants ---------------------------------------------------------*/
122 /* Private macros ------------------------------------------------------------*/
123 /* Private types -------------------------------------------------------------*/
124 /* Private variables ---------------------------------------------------------*/
125 /* Private functions ---------------------------------------------------------*/
126 
127 /**
128  * @}
129  */
130 
131 /**
132  * @}
133  */
134 
135 #ifdef __cplusplus
136 }
137 #endif
138 
139 #endif //PSDK_CMDSET_OSDK_FUNC_H
140 
141 /****************** (C) COPYRIGHT DJI Innovations *****END OF FILE****/
Transparent data transmission from payload end to OSDK command ack data structure.
Definition: psdk_cmdset_osdk_func.h:105
Transparent data transmission from OSDK to payload end command ack data structure.
Definition: psdk_cmdset_osdk_func.h:91
#define OSDKFUNC_PSDK_TO_OSDK_MAX_LEN
Definition: psdk_cmdset_osdk_func.h:54
Transparent data transmission from OSDK to payload end command request data structure.
Definition: psdk_cmdset_osdk_func.h:84
#define OSDKFUNC_OSDK_TO_PSDK_MAX_LEN
Definition: psdk_cmdset_osdk_func.h:53
PSDK core include file.
Transparent data transmission from payload end to OSDK command request data structure.
Definition: psdk_cmdset_osdk_func.h:98