ZW_TransportEndpoint.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Silicon Laboratories Inc. <https://www.silabs.com/>
//
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef _ZW_TRANSPORTENDPOINT_H_
#define _ZW_TRANSPORTENDPOINT_H_
 
#include <ZW_classcmd.h>
#include <ZW_security_api.h>
#include <ZW_transport_api.h>
#include <ZAF_types.h>
 
typedef enum
{
  ZAF_ENQUEUE_STATUS_SUCCESS = 0, 
  ZAF_ENQUEUE_STATUS_TIMEOUT = 1, 
  ZAF_ENQUEUE_STATUS_BUFFER_OVERRUN = 2  
} EZAF_EnqueueStatus_t;
 
typedef struct _MULTICHAN_NODE_INFO_
{
  uint8_t BitMultiChannelEncap; 
  security_key_t security; 
} MULTICHAN_NODE_INFO;
 
typedef struct _MULTICHAN_NODE_INFO_PACKED_
{
  uint8_t security             : 4; 
  uint8_t unused               : 1; 
  uint8_t BitMultiChannelEncap : 1; 
  uint8_t unused2              : 1; 
  uint8_t unused3              : 1; 
} MULTICHAN_NODE_INFO_PACKED;
 
typedef struct
{
  MULTICHAN_DEST_NODE_ID node;
  MULTICHAN_NODE_INFO    nodeInfo;
}
destination_info_t;
 
typedef destination_info_t MULTICHAN_NODE_ID;
 
typedef struct
{
  MULTICHAN_DEST_NODE_ID_8bit  node;    // We cannot store 16bit NodeIDs in the NVM, because of backwards compatibility!
  MULTICHAN_NODE_INFO_PACKED   nodeInfoPacked;
} MULTICHAN_NODE_ID_PACKED;
 
/* Transmit options for ZW_SendDataEx */
typedef struct _TRANSMIT_OPTIONS_TYPE_EX_ {
  uint8_t S2_groupID;
  uint8_t txOptions;
  uint8_t sourceEndpoint;
  MULTICHAN_NODE_ID *pList;
  uint8_t list_length;
} TRANSMIT_OPTIONS_TYPE_EX;
 
/* Transmit options for ZW_SendDataEx */
typedef struct _TRANSMIT_OPTIONS_TYPE_SINGLE_EX_ {
  uint8_t txOptions;
  uint8_t txSecOptions; 
  uint8_t sourceEndpoint;
  MULTICHAN_NODE_ID* pDestNode;
} TRANSMIT_OPTIONS_TYPE_SINGLE_EX;
 
typedef enum _ENDPOINT_
{
  ENDPOINT_ROOT = 0,
  ENDPOINT_1,
  ENDPOINT_2,
  ENDPOINT_3,
  ENDPOINT_4,
  ENDPOINT_5,
  ENDPOINT_6,
  ENDPOINT_7,
  ENDPOINT_8,
  ENDPOINT_9
} ENDPOINT;
 
void ZW_TransportEndpoint_Init(void);
 
zaf_cc_list_t*
GetEndpointcmdClassList( bool secList, uint8_t endpoint);
 
EZAF_EnqueueStatus_t
ZAF_Transmit(
  uint8_t *pData,
  size_t   dataLength,
  TRANSMIT_OPTIONS_TYPE_SINGLE_EX *pTxOptionsEx,
  ZAF_TX_Callback_t pCallback);
 
received_frame_status_t
Transport_ApplicationCommandHandlerEx(
  RECEIVE_OPTIONS_TYPE_EX *rxOpt,
  ZW_APPLICATION_TX_BUFFER *pCmd,
  uint8_t   cmdLength);
 
 
void
RxToTxOptions( RECEIVE_OPTIONS_TYPE_EX *rxopt,
               TRANSMIT_OPTIONS_TYPE_SINGLE_EX **txopt);
 
 
bool
Check_not_legal_response_job(RECEIVE_OPTIONS_TYPE_EX *rxOpt);
 
 
bool is_multicast(RECEIVE_OPTIONS_TYPE_EX *rxOpt);
 
void
SetFlagSupervisionEncap(bool flag);
 
#endif /* _ZW_TRANSPORTENDPOINT_H_ */