1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
|
/**
* @file zcl.tunnel.h
* @brief ZCL Tunneling cluster header
* ZCL 7 section 10.6
* ZCL 8 section 10.6
* @copyright Copyright [2009 - 2020] Exegin Technologies Limited. All rights reserved.
*/
#ifndef ZCL_TUNNEL_H
# define ZCL_TUNNEL_H
#include "zcl/zcl.h"
/** Tunneling Server Attribute IDs */
enum ZbZclTunnelSvrAttrT {
ZCL_TUNNEL_ATTR_TIMEOUT = 0x0000 /**< CloseTunnelTimeout */
};
/* Tunneling Client commands */
enum {
ZCL_TUNNEL_SVR_CMD_REQUEST = 0x00,
ZCL_TUNNEL_SVR_CMD_CLOSE = 0x01,
ZCL_TUNNEL_SVR_CMD_DATA = 0x02,
ZCL_TUNNEL_SVR_CMD_ERROR = 0x03,
ZCL_TUNNEL_SVR_CMD_ACK = 0x04, /* for flow control */
ZCL_TUNNEL_SVR_CMD_READY = 0x05, /* for flow control */
ZCL_TUNNEL_SVR_CMD_SUPPORTED_REQ = 0x06
};
/* Tunneling Server commands */
enum {
ZCL_TUNNEL_CLI_CMD_RESPONSE = 0x00,
ZCL_TUNNEL_CLI_CMD_DATA = 0x01,
ZCL_TUNNEL_CLI_CMD_ERROR = 0x02,
ZCL_TUNNEL_CLI_CMD_ACK = 0x03,
ZCL_TUNNEL_CLI_CMD_READY = 0x04,
ZCL_TUNNEL_CLI_CMD_SUPPORTED_RSP = 0x05,
ZCL_TUNNEL_CLI_CMD_CLOSE_NOTIFY = 0x06
};
/** Tunneling Protocol ID enumerations */
enum ZbZclTunnelProtocolT {
ZCL_TUNNEL_PROTO_DLMS_COSEM = 0, /**< DLMS/COSEM (IEC 62056) */
ZCL_TUNNEL_PROTO_IEC_61107 = 1, /**< IEC 61107 */
ZCL_TUNNEL_PROTO_ANSI_C12 = 2, /**< ANSI C12 */
ZCL_TUNNEL_PROTO_M_BUS = 3, /**< M-BUS */
ZCL_TUNNEL_PROTO_SML = 4, /**< SML */
ZCL_TUNNEL_PROTO_CLIMATE_TALK = 5, /**< ClimateTalk */
ZCL_TUNNEL_PROTO_GB_HRGP = 6, /**< GB-HRGP */
ZCL_TUNNEL_PROTO_IPV4 = 7, /**< IP v4 */
ZCL_TUNNEL_PROTO_IPV6 = 8, /**< IP v6 */
ZCL_TUNNEL_PROTO_MANUFACTURER = 200, /**< Manufacturer-defined protocols */
ZCL_TUNNEL_PROTO_RESERVED = 0xff /**< Reserved */
};
/** Tunneling Status Values */
enum ZbZclTunnelStatusT {
ZCL_TUNNEL_STATUS_SUCCESS = 0x00, /**< Success */
ZCL_TUNNEL_STATUS_BUSY = 0x01, /**< Busy */
ZCL_TUNNEL_STATUS_NO_RESOURCES = 0x02, /**< No more tunnel IDs */
ZCL_TUNNEL_STATUS_PROTO_UNSUPPORTED = 0x03, /**< Protocol not supported */
ZCL_TUNNEL_STATUS_FLOW_UNSUPPORTED = 0x04 /**< Flow control not supported */
};
/** Tunneling Transfer Data Status Values */
enum ZbZclTunnelXferStatusT {
ZCL_TUNNEL_XFER_STATUS_NO_TUNNEL = 0x00, /**< No such tunnel */
ZCL_TUNNEL_XFER_STATUS_WRONG_DEVICE = 0x01, /**< Wrong device */
ZCL_TUNNEL_XFER_STATUS_OVERFLOW = 0x02, /**< Data overflow */
ZCL_TUNNEL_XFER_STATUS_NO_RESPONSE = 0xff /**< No Response - If zcl_tunnel_handle_data returns
* ZCL_TUNNEL_XFER_STATUS_NO_RESPONSE, don't send a response
*/
};
struct ZbZclTunnelStateT;
/** ZbZclTunnelServerAddProto and ZbZclTunnelClientAddProto callback data structure */
struct ZbZclTunnelProtoCbT {
enum ZbZclTunnelStatusT (*request)(struct ZbZclClusterT *clusterPtr,
struct ZbZclTunnelStateT *statePtr, void *priv);
/**< Callback to the request handler. Only applicable for Tunnel Server cluster. */
void (*input)(struct ZbZclClusterT *clusterPtr, struct ZbZclTunnelStateT *statePtr, void *priv);
/**< Callback to the input handler */
void (*close)(struct ZbZclClusterT *clusterPtr, struct ZbZclTunnelStateT *statePtr, void *priv);
/**< Callback to the close handler (Optional). Required if the application needs to keep track of
* open tunnels, e.g., for persistence */
bool (*error)(struct ZbZclClusterT *clusterPtr, struct ZbZclTunnelStateT *statePtr, void *priv,
enum ZbZclTunnelXferStatusT status);
/**< Callback to the error handler (Optional). To handle ZCL_TUNNEL_SVR_CMD_ERROR.
* Return false if tunnel should be closed */
void *priv;
/**< Application private data pointer */
};
/* Tunneling Server */
/**
* Create a new instance of the Tunneling Server cluster
* @param zb Zigbee stack instance
* @param endpoint Endpoint on which to create cluster
* @return Cluster pointer, or NULL if there is an error
*/
struct ZbZclClusterT * ZbZclTunnelServerAlloc(struct ZigBeeT *zb, uint8_t endpoint);
/**
* Add a protocol tunnel to the server
* @param cluster Cluster instance from which to send this command
* @param protocol Protocol ID enumeration
* @param mfr Manufacturer ID
* @param mtu Protocol's MTU
* @param callbacks Protocol callbacks
* @return ZCL_STATUS_SUCCESS if successful, or other ZclStatusCodeT value on error
*/
enum ZclStatusCodeT ZbZclTunnelServerAddProto(struct ZbZclClusterT *cluster, enum ZbZclTunnelProtocolT protocol,
uint16_t mfr, uint16_t mtu, struct ZbZclTunnelProtoCbT *callbacks);
/**
* Get tunnel server state by tunnel ID
* @param cluster Cluster instance from which to send this command
* @param tunnel_id Tunnel ID
* @return State of the tunnel
*/
struct ZbZclTunnelStateT * ZbZclTunnelServerStateFindById(struct ZbZclClusterT *cluster, uint16_t tunnel_id);
/**
* Send data via the tunnel
* @param cluster Cluster instance from which to send this command
* @param state State of the tunnel
* @param data Data to send
* @param len Length of data being sent
* @param direction Direction to send (ZCL_DIRECTION_TO_SERVER or ZCL_DIRECTION_TO_CLIENT)
* @param callback Callback function to handle response
* @param arg Pointer to application data that will later be provided back to the callback function when invoked
* @return ZCL_STATUS_SUCCESS if successful, or other ZclStatusCodeT value on error
*/
enum ZclStatusCodeT ZbZclTunnelServerSendto(struct ZbZclClusterT *cluster,
struct ZbZclTunnelStateT *state, const uint8_t *data, unsigned int len, enum ZbZclDirectionT direction,
void (*callback)(struct ZbZclCommandRspT *rspPtr, void *arg), void *arg);
/**
* Send data to all tunnel clients with matching EUI
* @param cluster Cluster instance from which to send this command
* @param eui Extended Unique Identifier (EUI) address
* @param data Data to send
* @param len Length of data being sent
* @return Void
*/
void ZbZclTunnelServerSendAllMatch(struct ZbZclClusterT *cluster, uint64_t eui, void *data, unsigned int len);
/* Tunneling Client */
/**
* Create a new instance of the Tunneling Client cluster
* @param zb Zigbee stack instance
* @param endpoint Endpoint on which to create cluster
* @return Cluster pointer, or NULL if there is an error
*/
struct ZbZclClusterT * ZbZclTunnelClientAlloc(struct ZigBeeT *zb, uint8_t endpoint);
/**
* Add a protocol tunnel to the server
* @param cluster Cluster instance from which to send this command
* @param protocol Protocol ID enumeration
* @param mfr Manufacturer ID
* @param mtu Protocol's MTU
* @param callbacks Protocol callbacks
* @return ZCL_STATUS_SUCCESS if successful, or other ZclStatusCodeT value on error
*/
enum ZclStatusCodeT ZbZclTunnelClientAddProto(struct ZbZclClusterT *cluster, enum ZbZclTunnelProtocolT protocol,
uint16_t mfr, uint16_t mtu, struct ZbZclTunnelProtoCbT *callbacks);
/**
* Send a Request Tunnel command
* @param cluster Cluster instance from which to send this command
* @param dst_addr Destination address for connection request
* @param dst_endpoint Destination endpoint for connection request
* @param callback Callback function to handle response
* @param state Tunneling Cluster State structure
* @param status Status of the tunnel
* @param arg Pointer to application data that will later be provided back to the callback function when invoked
* @return ZCL_STATUS_SUCCESS if successful, or other ZclStatusCodeT value on error
*/
enum ZclStatusCodeT ZbZclTunnelClientConnectReq(struct ZbZclClusterT *cluster, uint64_t dst_addr, uint8_t dst_ep,
void (*callback)(struct ZbZclClusterT *cluster, struct ZbZclTunnelStateT *state,
enum ZbZclTunnelStatusT status, void *arg), void *arg);
/**
* Send a Close Tunnel command
* @param cluster Cluster instance from which to send this command
* @param callback Callback function that will be invoked later when the response is received
* @param arg Pointer to application data that will later be provided back to the callback function when invoked
* @return ZCL_STATUS_SUCCESS if successful, or other ZclStatusCodeT value on error
*/
enum ZclStatusCodeT ZbZclTunnelClientCloseReq(struct ZbZclClusterT *cluster,
void (*callback)(struct ZbZclCommandRspT *zcl_rsp, void *arg), void *arg);
/**
* Close the local tunnel without informing the server
* @param cluster Cluster instance from which to send this command
* @return ZCL_STATUS_SUCCESS if successful, or other ZclStatusCodeT value on error
*/
enum ZclStatusCodeT ZbZclTunnelClientCloseQuietReq(struct ZbZclClusterT *cluster);
/**
* Send a Transfer Data command
* @param cluster Cluster instance from which to send this command
* @param data Data to send
* @param len Length of data being sent
* @param callback Callback function that will be invoked later when the response is received
* @param arg Pointer to application data that will later be provided back to the callback function when invoked
* @return ZCL_STATUS_SUCCESS if successful, or other ZclStatusCodeT value on error
*/
enum ZclStatusCodeT ZbZclTunnelClientSendReq(struct ZbZclClusterT *cluster, const uint8_t *data, uint16_t len,
void (*callback)(struct ZbZclCommandRspT *rspPr, void *arg), void *arg);
/* Tunneling Helper Functions */
/**
* Get ID using Tunneling Cluster State structure
* @param state Tunneling Cluster State structure
* @return Allocated tunnel ID
*/
uint16_t ZbZclTunnelStateGetId(struct ZbZclTunnelStateT *state);
/**
* Get Tunneling Protocol Instance using Tunneling Cluster State structure
* @param state Tunneling Cluster State structure
* @return Tunneling Protocol Instance structure
*/
enum ZbZclTunnelProtocolT ZbZclTunnelStateGetProtocol(struct ZbZclTunnelStateT *state);
/**
* Get received data using Tunneling Cluster State structure
* @param state Tunneling Cluster State structure
* @return Data receive buffer
*/
uint8_t * ZbZclTunnelStateGetDataPtr(struct ZbZclTunnelStateT *state);
/**
* Get received data length using Tunneling Cluster State structure
* @param state Tunneling Cluster State structure
* @return Length of data in the buffer
*/
uint32_t ZbZclTunnelStateGetDataLen(struct ZbZclTunnelStateT *state, bool clear_data);
#endif
|
