ZW_application_transport_interface.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_APPLICATION_TRANSPORT_INTERFACE_H_
#define _ZW_APPLICATION_TRANSPORT_INTERFACE_H_
 
#include <stddef.h>
#include <ZW_typedefs.h>
#include "ZW_classcmd.h"
 
#include "FreeRTOS.h" // needed for queue.h
#include "queue.h" // for QueueHandle_t
#include "QueueNotifying.h"
#include "ZW_transport_api.h"
#include "NodeMask.h"
#include "ZW_basis_api.h"
#include "Assert.h"
 
 
#define ZW_MAX_PAYLOAD_SIZE                         160
 
#define MULTICAST_NODE_LIST_SIZE                    64
 
#define TX_BUFFER_SIZE                              170
 
#define MAX_NODE_INFO_LENGTH 159
 
#define APPLICATION_INTERFACE_TRANSMIT_ENUM_OFFSET  (0x00)
#define APPLICATION_INTERFACE_COMMAND_ENUM_OFFSET   (0x40)
#define APPLICATION_INTERFACE_RECEIVE_ENUM_OFFSET   (0x80)
#define APPLICATION_INTERFACE_STATUS_ENUM_OFFSET    (0xC0)
 
typedef enum EProtocolType
{
  EPROTOCOLTYPE_ZWAVE = 0,
  EPROTOCOLTYPE_ZWAVE_AV,
  EPROTOCOLTYPE_ZWAVE_FOR_IP
} EProtocolType;
 
typedef enum ELibraryType
{
  ELIBRARYTYPE_CONTROLLER_STATIC     = 1, 
  ELIBRARYTYPE_CONTROLLER_PORTABLE   = 2, 
  ELIBRARYTYPE_SLAVE                 = 3, 
  ELIBRARYTYPE_SLAVE_BEFORE_ENHANCED = 4, 
  ELIBRARYTYPE_INSTALLER             = 5, 
  ELIBRARYTYPE_SLAVE_ROUTING         = 6, 
  ELIBRARYTYPE_CONTROLLER            = 7, 
  ELIBRARYTYPE_DUT                   = 8, 
  ELIBRARYTYPE_AVREMOTE              = 10, 
  ELIBRARYTYPE_AVDEVICE              = 11  
} ELibraryType;
 
typedef enum EInclusionState_t
{
  EINCLUSIONSTATE_EXCLUDED = 0,
  EINCLUSIONSTATE_UNSECURE_INCLUDED,
  EINCLUSIONSTATE_SECURE_INCLUDED
} EInclusionState_t;
 
typedef enum EListenBeforeTalkThreshold_t
{
  ELISTENBEFORETALKTRESHOLD_DEFAULT = 127
} EListenBeforeTalkThreshold_t;
 
typedef enum EtxPowerLevel_t
{
  ETXPOWERLEVEL_DEFAULT = 127
} EtxPowerLevel_t;
 
typedef enum EZwaveTransmitType
{
  EZWAVETRANSMITTYPE_STD = APPLICATION_INTERFACE_TRANSMIT_ENUM_OFFSET,
  EZWAVETRANSMITTYPE_EX,                                              
  EZWAVETRANSMITTYPE_BRIDGE,                                          
  EZWAVETRANSMITTYPE_MULTI,
  EZWAVETRANSMITTYPE_MULTI_EX,                                        
  EZWAVETRANSMITTYPE_MULTI_BRIDGE,                                    
  EZWAVETRANSMITTYPE_EXPLOREINCLUSIONREQUEST,                         
  EZWAVETRANSMITTYPE_EXPLOREEXCLUSIONREQUEST,                         
  EZWAVETRANSMITTYPE_NETWORKUPDATEREQUEST,                            
  EZWAVETRANSMITTYPE_NODEINFORMATION,                                 
  EZWAVETRANSMITTYPE_NODEINFORMATIONREQUEST,                          
  EZWAVETRANSMITTYPE_TESTFRAME,                                       
  EZWAVETRANSMITTYPE_SETSUCNODEID,                                    
  EZWAVETRANSMITTYPE_SENDSUCNODEID,                                   
  EZWAVETRANSMITTYPE_ASSIGNRETURNROUTE,                               
  EZWAVETRANSMITTYPE_DELETERETURNROUTE,                               
  EZWAVETRANSMITTYPE_REQUESTNEWROUTEDESTINATIONS,                     
  EZWAVETRANSMITTYPE_SEND_SLAVE_NODE_INFORMATION,                     
  EZWAVETRANSMITTYPE_SEND_SLAVE_DATA,                                 
  EZWAVETRANSMITTYPE_INCLUDEDNODEINFORMATION,                         
  EZWAVETRANSMITTYPE_SECURE,                                          
  EZWAVETRANSMITTYPE_NON_SECURE,                                      
  NUM_EZWAVETRANSMITTYPE                                              
} EZwaveTransmitType;
 
typedef enum ELearnStatus
{
  ELEARNSTATUS_ASSIGN_COMPLETE,             
  ELEARNSTATUS_ASSIGN_NODEID_DONE,          
  ELEARNSTATUS_ASSIGN_RANGE_INFO_UPDATE,    
  ELEARNSTATUS_ASSIGN_INFO_PENDING,         
  ELEARNSTATUS_ASSIGN_WAITING_FOR_FIND,     
  ELEARNSTATUS_SMART_START_IN_PROGRESS,     
  ELEARNSTATUS_LEARN_IN_PROGRESS,           
  ELEARNSTATUS_LEARN_MODE_COMPLETED_TIMEOUT,
  ELEARNSTATUS_LEARN_MODE_COMPLETED_FAILED  
} ELearnStatus;
 
typedef enum EZwaveCommandType
{
  EZWAVECOMMANDTYPE_GENERATE_RANDOM = APPLICATION_INTERFACE_COMMAND_ENUM_OFFSET, // 64
 
  EZWAVECOMMANDTYPE_NODE_INFO, // 65
 
  EZWAVECOMMANDTYPE_CLEAR_NETWORK_STATISTICS, // 66
 
  EZWAVECOMMANDTYPE_SET_LEARN_MODE, // 67
 
  EZWAVECOMMANDTYPE_SET_DEFAULT,  // 68
 
  EZWAVECOMMANDTYPE_SEND_DATA_ABORT, // 69
 
  EZWAVECOMMANDTYPE_SET_PROMISCUOUS_MODE, // 70
 
  EZWAVECOMMANDTYPE_SET_RF_RECEIVE_MODE, // 71
 
  EZWAVECOMMANDTYPE_IS_NODE_WITHIN_DIRECT_RANGE, // 72
 
  EZWAVECOMMANDTYPE_GET_NEIGHBOR_COUNT, // 73
 
  EZWAVECOMMANDTYPE_ARE_NODES_NEIGHBOURS, // 74
 
  EZWAVECOMMANDTYPE_IS_FAILED_NODE_ID, // 75
 
  EZWAVECOMMANDTYPE_GET_ROUTING_TABLE_LINE, // 76
 
  EZWAVECOMMANDTYPE_SET_ROUTING_INFO, // 77
 
  EZWAVECOMMANDTYPE_STORE_NODE_INFO, // 78
 
  EZWAVECOMMANDTYPE_STORE_HOMEID, // 79
 
  EZWAVECOMMANDTYPE_LOCK_ROUTE_RESPONSE, // 80
 
  EZWAVECOMMANDTYPE_GET_PRIORITY_ROUTE, // 81
 
  EZWAVECOMMANDTYPE_SET_PRIORITY_ROUTE, // 82
 
  EZWAVECOMMANDTYPE_SET_SLAVE_LEARN_MODE, // 83
 
  EZWAVECOMMANDTYPE_IS_VIRTUAL_NODE, // 84
 
  EZWAVECOMMANDTYPE_GET_VIRTUAL_NODES, // 85
 
  EZWAVECOMMANDTYPE_GET_CONTROLLER_CAPABILITIES, // 86
 
  EZWAVECOMMANDTYPE_SET_ROUTING_MAX, // 87
 
  EZWAVECOMMANDTYPE_IS_PRIMARY_CTRL, // 88
 
  // TODO:
  EZWAVECOMMANDTYPE_ADD_NODE_TO_NETWORK, // 89
 
  // TODO:
  EZWAVECOMMANDTYPE_REMOVE_NODE_FROM_NETWORK, // 90
 
  EZWAVECOMMANDTYPE_AES_ECB, // 91
 
  EZWAVECOMMANDTYPE_GET_BACKGROUND_RSSI, // 92
 
  EZWAVECOMMANDTYPE_REMOVE_FAILED_NODE_ID, // 93
 
  EZWAVECOMMANDTYPE_REPLACE_FAILED_NODE_ID, // 94
 
  EZWAVECOMMANDTYPE_PM_STAY_AWAKE, // 95 - OBSOLETED
  EZWAVECOMMANDTYPE_PM_CANCEL, // 96 - OBSOLETED
  EZWAVECOMMANDTYPE_PM_REGISTER, // 97 - OBSOLETED
 
  // TODO:
  EZWAVECOMMANDTYPE_ZW_UPDATE_CTRL_NODE_INFORMATION, // 98
 
  EZWAVECOMMANDTYPE_ZW_SET_LBT_THRESHOLD, // 99
 
  // TODO:
  EZWAVECOMMANDTYPE_ADD_NODE_DSK_TO_NETWORK, // 100
 
  EZWAVECOMMANDTYPE_NETWORK_LEARN_MODE_START, // 101
 
  EZWAVECOMMANDTYPE_CREAT_NEW_PRIMARY_CTRL, // 102
 
  EZWAVECOMMANDTYPE_CONTROLLER_CHANGE, // 103
 
  EZWAVECOMMANDTYPE_CLEAR_TX_TIMERS,  // 104
 
  EZWAVECOMMANDTYPE_ZW_SET_MAX_INCL_REQ_INTERVALS, // 105
 
  // TODO:
  EZWAVECOMMANDTYPE_NVM_BACKUP_OPEN, // 106
 
  // TODO:
  EZWAVECOMMANDTYPE_NVM_BACKUP_READ, // 107
 
  // TOOD:
  EZWAVECOMMANDTYPE_NVM_BACKUP_WRITE, // 108
 
  // TODO:
  EZWAVECOMMANDTYPE_NVM_BACKUP_CLOSE, // 109
 
  EZWAVECOMMANDTYPE_PM_SET_POWERDOWN_CALLBACK, // 110
 
  EZWAVECOMMANDTYPE_SET_SECURITY_KEYS, // 111
 
  // TODO:
  EZWAVECOMMANDTYPE_SOFT_RESET, // 112
 
  // TODO:
  EZWAVECOMMANDTYPE_BOOTLOADER_REBOOT, // 113
 
  // TODO:
  EZWAVECOMMANDTYPE_REMOVE_NODEID_FROM_NETWORK, // 114
 
  EZWAVECOMMANDTYPE_ZW_GET_INCLUDED_NODES, // 115
 
  EZWAVECOMMANDTYPE_REQUESTNODENEIGHBORUPDATE, // 116
 
  EZWAVECOMMANDTYPE_ZW_INITIATE_SHUTDOWN, // 117
 
  EZWAVECOMMANDTYPE_ZW_GET_INCLUDED_LR_NODES, // 118
 
  EZWAVECOMMANDTYPE_ZW_GET_LR_CHANNEL, // 119
 
  EZWAVECOMMANDTYPE_ZW_SET_LR_CHANNEL, // 120
 
  EZWAVECOMMANDTYPE_ZW_SET_LR_VIRTUAL_IDS, // 121
 
  EZWAVECOMMANDTYPE_UNUSED1, //122
  EZWAVECOMMANDTYPE_UNUSED2, //123
 
  EZWAVECOMMANDTYPE_ZW_GET_PTI_CONFIG,  // 124
 
  EZWAVECOMMANDTYPE_ZW_SET_TX_ATTENUATION, // 125
 
 
  /*********************************************
   * SECURE API interface functions used in apps.
   ********************************************/
  EZWAVECOMMANDTYPE_SECURE_NETWORK_MANAGEMENT_ADD_NODE, // 126
 
  EZWAVECOMMANDTYPE_SECURE_NETWORK_MANAGEMENT_ABORT, // 127
 
  EZWAVECOMMANDTYPE_SECURE_NETWORK_MANAGEMENT_REMOVE_NODE, // 128
 
  EZWAVECOMMANDTYPE_SECURE_SEND_DATA, // 129
 
  EZWAVECOMMANDTYPE_SECURE_NETWORK_MANAGEMENT_LEARN_MODE_INCLUSION, // 130
 
  EZWAVECOMMANDTYPE_SECURE_NETWORK_MANAGEMENT_LEARN_MODE_EXCLUSION, // 131
 
  EZWAVECOMMANDTYPE_SECURE_NETWORK_MANAGEMENT_SET_SECURITY_FLAGS, // 132
 
  EZWAVECOMMANDTYPE_ZW_GET_TX_POWER_MAX_SUPPORTED,
  EZWAVECOMMANDTYPE_REQUESTNODETYPE_NEIGHBORUPDATE, // 134
 
  NUM_EZWAVECOMMANDTYPE
} EZwaveCommandType;
 
typedef enum EZwaveCommandStatusType
{
  EZWAVECOMMANDSTATUS_TX = APPLICATION_INTERFACE_STATUS_ENUM_OFFSET,
  EZWAVECOMMANDSTATUS_GENERATE_RANDOM,                              
  EZWAVECOMMANDSTATUS_NODE_INFO,                                    
  EZWAVECOMMANDSTATUS_LEARN_MODE_STATUS,                            
  EZWAVECOMMANDSTATUS_SET_DEFAULT,                                  
  EZWAVECOMMANDSTATUS_INVALID_TX_REQUEST,                           
  EZWAVECOMMANDSTATUS_INVALID_COMMAND,                              
  EZWAVECOMMANDSTATUS_SET_RF_RECEIVE_MODE,                          
  EZWAVECOMMANDSTATUS_IS_NODE_WITHIN_DIRECT_RANGE,                  
  EZWAVECOMMANDSTATUS_GET_NEIGHBOR_COUNT,                           
  EZWAVECOMMANDSTATUS_ARE_NODES_NEIGHBOURS,                         
  EZWAVECOMMANDSTATUS_IS_FAILED_NODE_ID,                            
  EZWAVECOMMANDSTATUS_GET_ROUTING_TABLE_LINE,                       
  EZWAVECOMMANDSTATUS_SET_ROUTING_INFO,                             
  EZWAVECOMMANDSTATUS_STORE_NODE_INFO,                              
  EZWAVECOMMANDSTATUS_GET_PRIORITY_ROUTE,                           
  EZWAVECOMMANDSTATUS_SET_PRIORITY_ROUTE,                           
  EZWAVECOMMANDSTATUS_SET_SLAVE_LEARN_MODE,                         
  EZWAVECOMMANDSTATUS_SET_SLAVE_LEARN_MODE_RESULT,                  
  EZWAVECOMMANDSTATUS_IS_VIRTUAL_NODE,                              
  EZWAVECOMMANDSTATUS_GET_VIRTUAL_NODES,                            
  EZWAVECOMMANDSTATUS_GET_CONTROLLER_CAPABILITIES,                  
  EZWAVECOMMANDSTATUS_IS_PRIMARY_CTRL,                              
  EZWAVECOMMANDSTATUS_NETWORK_MANAGEMENT,                           
  EZWAVECOMMANDSTATUS_GET_BACKGROUND_RSSI,                          
  EZWAVECOMMANDSTATUS_AES_ECB,                                      
  EZWAVECOMMANDSTATUS_REMOVE_FAILED_NODE_ID,                        
  EZWAVECOMMANDSTATUS_REPLACE_FAILED_NODE_ID,                       
  EZWAVECOMMANDSTATUS_NETWORK_LEARN_MODE_START,                     
  EZWAVECOMMANDSTATUS_ZW_SET_MAX_INCL_REQ_INTERVALS,                
  EZWAVECOMMANDSTATUS_NVM_BACKUP_RESTORE,                           
  EZWAVECOMMANDSTATUS_PM_SET_POWERDOWN_CALLBACK,                    
  EZWAVECOMMANDSTATUS_ZW_GET_INCLUDED_NODES,                        
  EZWAVECOMMANDSTATUS_ZW_REQUESTNODENEIGHBORUPDATE,                 
  EZWAVECOMMANDSTATUS_ZW_REQUESTNODETYPE_NEIGHBORUPDATE,             
  EZWAVECOMMANDSTATUS_ZW_INITIATE_SHUTDOWN,                         
  EZWAVECOMMANDSTATUS_ZW_GET_INCLUDED_LR_NODES,                     
  EZWAVECOMMANDSTATUS_ZW_GET_LR_CHANNEL,                            
  EZWAVECOMMANDSTATUS_UNUSED1,                                      
  EZWAVECOMMANDSTATUS_UNUSED2,                                      
  EZWAVECOMMANDSTATUS_ZW_GET_PTI_CONFIG,                            
  EZWAVECOMMANDSTATUS_ZW_SET_TX_ATTENUATION,                        
  /***********************************
   * SECURE notifications to app
   **********************************/
  EZWAVECOMMANDSTATUS_SECURE_ON_NODE_ADDED,                         
  EZWAVECOMMANDSTATUS_SECURE_ON_NODE_DELETED,                       
  EZWAVECOMMANDSTATUS_SECURE_ON_NEW_NETWORK_ENTERED,                
  EZWAVECOMMANDSTATUS_SECURE_ON_NETWORK_MANAGEMENT_STATE_UPDATE,    
  EZWAVECOMMANDSTATUS_SECURE_ON_NEW_SUC,                            
  EZWAVECOMMANDSTATUS_SECURE_ON_FRAME_TRANSMISSION,                 
  EZWAVECOMMANDSTATUS_SECURE_ON_RX_FRAME_RECEIVED_INDICATOR,        
  EZWAVECOMMANDSTATUS_ZW_SET_LR_CHANNEL,                            
  EZWAVECOMMANDSTATUS_ZW_GET_TX_POWER_MAX_SUPPORTED,                
  NUM_EZWAVECOMMANDSTATUS,                                          
  EZWAVECOMMANDSTATUS_INVALID = 0xFF
} EZwaveCommandStatusType;
 
typedef enum EZwaveReceiveType
{
  EZWAVERECEIVETYPE_SINGLE = APPLICATION_INTERFACE_RECEIVE_ENUM_OFFSET,
  EZWAVERECEIVETYPE_MULTI,                                             
  EZWAVERECEIVETYPE_NODE_UPDATE,                                       
  EZWAVERECEIVETYPE_SECURITY_EVENT,                                    
  EZWAVERECEIVETYPE_STAY_AWAKE,                                        
  EZWAVERECEIVETYPE_SECURE_FRAME_RECEIVED,                             
  NUM_EZWAVERECEIVETYPE,                                               
  EZWAVERECEIVETYPE_INVALID = 0xFF
} EZwaveReceiveType;
 
typedef struct SNetworkUpdateRequest
{
  void            (*Handle)(void); 
                                   // Allows application to recognize frames
} SNetworkUpdateRequest;
 
 
typedef enum ELearnMode
{
  ELEARNMODE_DISABLED = 0,
  ELEARNMODE_CLASSIC = 1,
  ELEARNMODE_NETWORK_WIDE_INCLUSION = 2,
  ELEARNMODE_NETWORK_WIDE_EXCLUSION = 3
} ELearnMode;
 
typedef struct SNodeInfoRequest
{
 
  void            (*Handle)(void); // Placeholder for callback function
                                   // Will be returned with transmit status
                                   // Allows application to recognize frames
  node_id_t DestNodeId;
} SNodeInfoRequest;
 
typedef struct SNodeInfo
{
  void            (*Handle)(void);  // Placeholder for callback function
                                    // Will be returned with transmit status
                                    // Allows application to recognize frames
  node_id_t DestNodeId;
  uint8_t TransmitOptions;
} SNodeInfo;
 
 
// Command structures START -------------------------------------------
 
typedef struct SCommandClassList_t
{
  uint8_t   iListLength;
  uint8_t * pCommandClasses;
} SCommandClassList_t;
 
typedef struct SCommandClassSet_t
{
  SCommandClassList_t UnSecureIncludedCC;       
  SCommandClassList_t SecureIncludedUnSecureCC; 
  SCommandClassList_t SecureIncludedSecureCC;   
} SCommandClassSet_t;
 
typedef struct SCommandClassVersions
{
  uint8_t SecurityVersion;
  uint8_t Security2Version;
  uint8_t TransportServiceVersion;
} SCommandClassVersions;
 
typedef struct SCommandGenerateRandom
{
  uint8_t iLength;  
} SCommandGenerateRandom;
 
typedef struct SCommandNodeInfo
{
  node_id_t NodeId;
} SCommandNodeInfo;
 
typedef struct SCommandClearNetworkStatistics
{
  uint8_t Reserved;             // Not required set
} SCommandClearNetworkStatistics;
 
typedef struct SCommandSetLearnMode
{
  ELearnMode  eLearnMode;
  uint8_t useCB;
} SCommandSetLearnMode;
 
typedef struct SCommandSetSmartStartLearnMode
{
  E_NETWORK_LEARN_MODE_ACTION  eLearnMode;
} SCommandSetSmartStartLearnMode;
 
typedef struct SSetSucNodeId
{
  void            (*Handle)(void); 
  node_id_t SucNodeId;
  bool      bSucEnable;
  bool      bTxLowPower;
  uint8_t   Capabilities;         /* The capabilities of the new SUC */
} SSetSucNodeId;
 
typedef struct SCommandSetRfPowerLevel
{
 
    uint8_t powerLevelDBm;
} SCommandSetRfPowerLevel;
 
typedef struct SSendSucNodeId
{
 
  void            (*Handle)(void); 
  node_id_t DestNodeId;
  uint8_t TransmitOptions;
} SSendSucNodeId;
 
 
typedef struct SCommandSetPromiscuousMode
{
  uint8_t Enable;
} SCommandSetPromiscuousMode;
 
typedef struct SAssignReturnRoute
{
  void            (*Handle)(void);      
 
  node_id_t ReturnRouteReceiverNodeId;  
  node_id_t RouteDestinationNodeId;     
  uint8_t   aPriorityRouteRepeaters[4]; 
  uint8_t   PriorityRouteSpeed;
  uint8_t   isSucRoute;
} SAssignReturnRoute;
 
typedef struct SCommandSetRfReceiveMode
{
 
  uint8_t mode;
} SCommandSetRfReceiveMode;
 
typedef struct SDeleteReturnRoute
{
  void            (*Handle)(void); 
 
  node_id_t DestNodeId;            
  bool bDeleteSuc;                 
} SDeleteReturnRoute;
 
typedef struct SCommandGeniric8bParameter
{
  uint8_t value;
} SCommandGeniric8bParameter;
 
typedef struct SCommandGeniric16bParameter
{
  uint16_t value;
} SCommandGeniric16bParameter;
 
typedef struct SCommandAreNodesNeighbours
{
  uint8_t NodeA;
  uint8_t NodeB;
} SCommandAreNodesNeighbours;
 
typedef struct SCommandGetRoutingInfo
{
  node_id_t nodeID;
  uint8_t   options;
} SCommandGetRoutingInfo;
 
typedef struct SSendSlaveNodeInformation
{
  void            (*Handle)(void); 
  node_id_t sourceId;
  node_id_t destinationId;
  uint8_t txOptions;
} SSendSlaveNodeInformation;
 
 
typedef struct SCommandSetRoutingInfo
{
  uint8_t nodeID;
  uint8_t length;
  uint8_t nodeMask[MAX_NODEMASK_LENGTH];
} SCommandSetRoutingInfo;
 
typedef struct SCommandStoreNodeInfo
{
  uint8_t nodeID;
  uint8_t nodeInfo[6];
} SCommandStoreNodeInfo;
 
typedef struct SCommandStoreHomeID
{
  uint8_t homeID[HOMEID_LENGTH];
  uint8_t nodeID;
} SCommandStoreHomeID;
 
typedef struct SCommandSetPriorityRoute
{
  node_id_t nodeID;
  uint8_t   repeaters[MAX_REPEATERS];
  uint8_t   routeSpeed;
  uint8_t   clearGolden;
} SCommandSetPriorityRoute;
 
typedef struct SCommandAesEcb
{
  uint8_t key[16];
  uint8_t inputData[16];
} SCommandAesEcb;
 
 
typedef struct SCommandGetPriorityRoute
{
  uint8_t   *pPriRouteBuffer;              
  node_id_t nodeID;
} SCommandGetPriorityRoute;
 
typedef struct SCommandFailedNodeIDCmd
{
  node_id_t nodeID;
  uint8_t   normalPower;      //Only for replaced failed node api
} SCommandFailedNodeIDCmd;
 
typedef struct SCommandPMSetPowerDownCallback {
   void (*callback)(void);
} SCommandPMSetPowerDownCallback;
 
typedef struct SCommandSetLBTThreshold {
    uint8_t channel;
    int8_t level;
}
SCommandSetLBTThreshold;
 
typedef struct SCommandSetMaxInclReqInterval {
    uint32_t inclusionRequestInterval;
} SCommandSetMaxInclReqInterval;
 
typedef struct SCommandNvmBackupRestore {
   uint32_t offset;
   uint32_t length;
   uint8_t  *nvmData;
} SCommandNvmBackupRestore;
 
typedef struct SCommandSetSecurityKeys
{
  uint8_t keys;
} SCommandSetSecurityKeys;
 
// Command structures END ---------------------------------------------
 
typedef struct SProtocolVersion
{
  uint8_t Major;
  uint8_t Minor;
  uint8_t Revision;
} SProtocolVersion;
 
typedef struct SProtocolInfo
{
  SCommandClassVersions CommandClassVersions; 
  SProtocolVersion      ProtocolVersion;      
  EProtocolType         eProtocolType;
  ELibraryType          eLibraryType;         
} SProtocolInfo;
 
typedef struct SNetworkInfo
{
  EInclusionState_t   eInclusionState;
  node_id_t           SucNodeId;
  uint8_t             SecurityKeys;     // Which security keys the node has
  node_id_t           NodeId;
  uint32_t            HomeId;
  uint16_t            MaxPayloadSize;
} SNetworkInfo;
 
typedef struct SLongRangeInfo
{
  uint16_t  MaxLongRangePayloadSize;
} SLongRangeInfo;
 
typedef struct t_ExtNodeInfo
{
   NODEINFO  NodeInfo;
   uint8_t   extInfo;
} t_ExtNodeInfo;
 
typedef struct SRadioStatus
{
  int8_t iRadioPowerLevel;  // Radio power in db. 0 -> Max power.
} SRadioStatus;
 
typedef struct SApplicationHandles
{
  SQueueNotifying*                  pZwTxQueue;    
  QueueHandle_t                     ZwRxQueue;     
  SQueueNotifying*                  pZwCommandQueue; 
  QueueHandle_t                     ZwCommandStatusQueue;   
  const zpal_radio_network_stats_t* pNetworkStatistics;  
  const SProtocolInfo*              pProtocolInfo;
 
  const SNetworkInfo*               pNetworkInfo;
 
  const SLongRangeInfo*             pLongRangeInfo;  
  const SRadioStatus*               pRadioStatus;
 
} SApplicationHandles;
 
typedef struct SRadioConfig_t
{
  int8_t iListenBeforeTalkThreshold;  
  zpal_tx_power_t iTxPowerLevelMax;   
  zpal_tx_power_t iTxPowerLevelAdjust;
  int16_t iTxPowerLevelMaxLR;         
  zpal_radio_region_t eRegion;        
  uint8_t radio_debug_enable;         
} SRadioConfig_t;
 
typedef struct SAppNodeInfo_t
{
  uint8_t             DeviceOptionsMask;
  APPL_NODE_TYPE      NodeType;
} SAppNodeInfo_t;
 
typedef struct SVirtualSlaveNodeInfo_t
{
  node_id_t           NodeId;
  bool                bListening; 
  APPL_NODE_TYPE      NodeType;
  SCommandClassList_t CommandClasses;
} SVirtualSlaveNodeInfo_t;
 
typedef struct SVirtualSlaveNodeInfoTable_t
{
  uint8_t                         iTableLength;
  const SVirtualSlaveNodeInfo_t ** ppNodeInfo;  
} SVirtualSlaveNodeInfoTable_t;                 
 
typedef struct SProtocolConfig_t
{
  const SVirtualSlaveNodeInfoTable_t *        pVirtualSlaveNodeInfoTable; 
  const uint8_t *                             pSecureKeysRequested;   
  const SAppNodeInfo_t *                      pNodeInfo;
  const SRadioConfig_t *                      pRadioConfig;
} SProtocolConfig_t;
 
typedef struct STransmitFrameConfig
{
  void (*Handle) (uint8_t txStatus, TX_STATUS_TYPE* extendedTxStatus);
  uint8_t TransmitOptions;
  uint8_t iFrameLength;
  uint8_t aFrame[TX_BUFFER_SIZE];
} STransmitFrameConfig;
 
// Basis API
typedef struct SExploreInclusionRequest
{
  uint8_t Reserved;               // Not required set
} SExploreInclusionRequest;
 
typedef struct SExploreExclusionRequest
{
  uint8_t Reserved;               // Not required set
} SExploreExclusionRequest;
 
typedef struct SIncludedNodeInfo
{
  void (*Handle)(uint8_t, TX_STATUS_TYPE*); 
}
SIncludedNodeInfo;
 
typedef struct STest
{
  #ifdef ZW_SLAVE
  void (*Handle)(void *);      // Will be returned with transmit status
                               // Allows application to recognize frames
  #else
  void (*Handle)(uint8_t, TX_STATUS_TYPE*);
  #endif
  node_id_t DestNodeId;
  uint8_t PowerLevel;
} STest;
 
// Transport API
typedef struct SSendData
{
  STransmitFrameConfig FrameConfig;
  node_id_t DestNodeId;
} SSendData;
 
typedef struct SSendDataEx
{
  STransmitFrameConfig FrameConfig;
  node_id_t DestNodeId;
  node_id_t SourceNodeId;
  uint8_t TransmitSecurityOptions;
  uint8_t TransmitOptions2;
  enum SECURITY_KEY eKeyType;
} SSendDataEx;
 
typedef struct SSendDataBridge
{
  STransmitFrameConfig FrameConfig;
  node_id_t DestNodeId;
  node_id_t SourceNodeId;
} SSendDataBridge;
 
typedef struct SSendDataMulti
{
  STransmitFrameConfig FrameConfig;
  NODE_MASK_TYPE NodeMask;
} SSendDataMulti;
 
typedef struct SSendDataMultiEx
{
  STransmitFrameConfig FrameConfig;
  uint8_t SourceNodeId;
  uint8_t GroupId;
  enum SECURITY_KEY eKeyType;
} SSendDataMultiEx;
 
typedef struct SSendDataMultiBridge
{
  STransmitFrameConfig FrameConfig;
  uint8_t NodeMask[MULTICAST_NODE_LIST_SIZE];
  node_id_t      SourceNodeId;
  bool lr_nodeid_list;
} SSendDataMultiBridge;
 
// Controller  API
typedef struct SCommandNetworkManagement
{
  void            (*pHandle)(void); // Placeholder for callback function
                                   // Will be returned with transmit status
                                   // Allows application to recognize frames
  uint8_t   mode;
  node_id_t nodeID;
} SCommandNetworkManagement;
 
 
// Slave API
typedef struct SRequestNewRouteDestinations
{
  void    (*Handle)(void);      
  uint8_t iDestinationCount;    
  uint8_t aNewDestinations[ZW_MAX_CACHED_RETURN_ROUTE_DESTINATIONS];                 
} SRequestNewRouteDestinations;
 
typedef struct SCommandNetworkManagementDSK
{
  void           (*pHandle)(void); 
  uint8_t mode;
  uint8_t dsk[8];            
} SCommandNetworkManagementDSK;
 
typedef struct SZWaveTransmitStatus
{
  void            (*Handle)(void); 
  bool            bIsTxFrameLegal;  
  uint8_t         TxStatus;
  TX_STATUS_TYPE  ExtendedTxStatus;
} SZWaveTransmitStatus;
 
typedef struct SZWaveGenerateRandomStatus
{
  uint8_t iLength;
  uint8_t aRandomNumber[32];
} SZWaveGenerateRandomStatus;
 
typedef struct SZWaveNodeInfoStatus
{
  node_id_t NodeId;
  t_ExtNodeInfo extNodeInfo;  // if NodeInfo.nodeType.generic = 0, node does not exist.
} SZWaveNodeInfoStatus;
 
typedef struct SZWaveLearnModeStatus
{
  ELearnStatus Status;   /* Status of learn mode */
} SZWaveLearnModeStatus;
 
typedef struct SZWaveInvalidTxRequestStatus
{
  uint8_t InvalidTxRequest;   /* Invalid value received (value should have been a valid EZWAVETRANSMITTYPE) */
} SZWaveInvalidTxRequestStatus;
 
typedef struct SZWaveInvalidCommandStatus
{
  EZwaveCommandType InvalidCommand;     /* Invalid value received (value should have been a valid EZWAVECOMMANDTYPE) */
} SZWaveInvalidCommandStatus;
 
typedef struct SZWaveGeneric8bStatus
{
  uint8_t result;     /* generic value of any API that uses a byte as a return value*/
} SZWaveGeneric8bStatus;
 
typedef struct SZWaveGenericBoolStatus
{
 
  bool result;     /* generic value of any API that uses a boolean as a return value*/
} SZWaveGenericBoolStatus;
 
typedef struct SCommandRequestNodeNeighborUpdate
{
  void            (*Handle)(void); // Placeholder for callback function
                                   // Will be returned with transmit status
                                   // Allows application to recognize frames
 
  node_id_t NodeId;                // Node to have its neighbors discovered..
} SCommandRequestNodeNeighborUpdate;
 
typedef struct SCommandRequestNodeTypeNeighborUpdate
{
  void            (*Handle)(void); // Placeholder for callback function
                                   // Will be returned with transmit status
                                   // Allows application to recognize frames
 
  E_SYSTEM_TYPE NodeType;
  node_id_t NodeId;                // Node to have its neighbors discovered..
} SCommandRequestNodeTypeNeighborUpdate;
 
typedef struct SZWaveGetRoutingInfoStatus
{
 
  uint8_t RoutingInfo[MAX_NODEMASK_LENGTH];
} SZWaveGetRoutingInfoStatus;
 
 
typedef struct SCommandInitiateShutdown
{
  void (*Handle) (void);      // Placeholder for callback function
 
} SCommandInitiateShutdown;
 
 
typedef struct SCommandSetSecurityFlags
{
  node_id_t nodeID;
  bool nodeS2Capable;
  bool nodeS2Included;
  bool nodeSecureIncluded;
} SCommandSetSecurityFlags;
 
typedef struct SZWaveGetPriorityRouteStatus
{
  uint8_t bAnyRouteFound;
  uint8_t repeaters[MAX_REPEATERS];
  uint8_t routeSpeed;
} SZWaveGetPriorityRouteStatus;
 
typedef struct SZWaveSetPriorityRouteStatus
{
  uint8_t bRouteUpdated;
} SZWaveSetPriorityRouteStatus;
 
typedef struct SZWaveGetVirtualNodesStatus
{
  uint8_t vNodesMask[MAX_NODEMASK_LENGTH];
} SZWaveGetVirtualNodesStatus;
 
typedef struct SZWaveAesEcbStatus
{
  uint8_t outputData[16];
} SZWaveAesEcbStatus;
 
typedef struct SZWaveGetBackgroundRssiStatus
{
  int8_t rssi[ZPAL_RADIO_NUM_CHANNELS_LR_CH_CFG_1_2];
} SZWaveGetBackgroundRssiStatus;
 
typedef struct SZWaveNetworkManagementStatus
{
  void *pHandle;
  /*learn status can be sourceID, destinationID , data length and data can be up to NODEPARM_MAX*/
  uint8_t statusInfo[5 + NODEPARM_MAX];
} SZWaveNetworkManagementStatus;
 
typedef struct SNvmBackupRestoreStatus
{
  uint8_t status;
} SNvmBackupRestoreStatus;
 
typedef struct SZWaveGetIncludedNodes
{
  NODE_MASK_TYPE node_id_list;
} SZWaveGetIncludedNodes;
 
typedef struct SZWaveGetIncludedNodesLR
{
  LR_NODE_MASK_TYPE node_id_list;
} SZWaveGetIncludedNodesLR;
 
typedef struct SZWaveTxPowerMaxSupported
{
  zpal_tx_power_t tx_power_max_supported;
} SZWaveTxPowerMaxSupported;
 
// Receive structures -----------------------------------
 
typedef struct SReceiveNodeUpdate
{
  uint8_t Status;   // The status of the update process, value could be one of the following :
                    // \ref UPDATE_STATE_ADD_DONE A new node has been added to the network.
                    // \ref UPDATE_STATE_DELETE_DONE A node has been deleted from the network.
                    // \ref UPDATE_STATE_NODE_INFO_RECEIVED A node has sent its node info either unsolicited
                    // or as a response to a \ref NodeInfoRequest being passed to protocol.
                    // -\ref UPDATE_STATE_SUC_ID The SIS node Id was updated.
 
  node_id_t NodeId; // The updated node's node ID (1..232).
  uint8_t iLength;                          // length of aPayload.
  uint8_t aPayload[MAX_NODE_INFO_LENGTH]; // the updated node's node info.
} SReceiveNodeUpdate;
 
 
/* Used by protocol to request/inform Application
* of Security based Events.Currently only an event for Client Side Authentication(CSA)
* has been defined - E_APPLICATION_SECURITY_EVENT_S2_INCLUSION_REQUEST_DSK_CSA.
*
* \ref E_APPLICATION_SECURITY_EVENT_S2_INCLUSION_REQUEST_DSK_CSA Security Event
*   Is posted by protocol when in S2 inclusion with CSA enabled and the
*   Server side DSK is needed.
*   Application must call ZW_SetSecurityS2InclusionCSA_DSK(s_SecurityS2InclusionCSAPublicDSK_t *)
*   with the retrieved Server / Controller side DSK.
*/
typedef struct SReceiveSecurityEvent
{
  e_application_security_event_t Event; // Event type
  uint8_t iLength;                      // Length of security event payload
  uint8_t aEventData[48];               // Security Event payload
} SReceiveSecurityEvent;
 
typedef union UTransmitParameters
{
  // Basis API
  SExploreInclusionRequest        ExploreInclusionRequest;
  SExploreExclusionRequest        ExploreExclusionRequest;
  SNetworkUpdateRequest           NetworkUpdateRequest;
  SNodeInfoRequest                NodeInfoRequest;
  SNodeInfo                       NodeInfo;
  SIncludedNodeInfo               IncludedNodeInfo;
  STest                           Test;
  // Transport API
  SSendData                       SendData;
  SSendDataEx                     SendDataEx;
  SSendDataBridge                 SendDataBridge;
  SSendDataMulti                  SendDataMulti;
  SSendDataMultiEx                SendDataMultiEx;
  SSendDataMultiBridge            SendDataMultiBridge;
  // Controller API
  SSetSucNodeId                   SetSucNodeId;
  SSendSucNodeId                  SendSucNodeId;
  SAssignReturnRoute              AssignReturnRoute;
  SDeleteReturnRoute              DeleteReturnRoute;
  SSendSlaveNodeInformation       SendSlaveNodeInformation;
  // Slave API
  SRequestNewRouteDestinations    RequestNewRouteDestinations;
} UTransmitParameters;
 
typedef union UCommandStatus
{
  SZWaveTransmitStatus          TxStatus;
  SZWaveGenerateRandomStatus    GenerateRandomStatus;
  SZWaveNodeInfoStatus          NodeInfoStatus;
  SZWaveLearnModeStatus         LearnModeStatus;
  SZWaveInvalidTxRequestStatus  InvalidTxRequestStatus;
  SZWaveInvalidCommandStatus    InvalidCommandStatus;
  SZWaveGeneric8bStatus         SetRFReceiveModeStatus;
  SZWaveGeneric8bStatus         IsNodeWithinDirectRange;
  SZWaveGeneric8bStatus         GetNeighborCountStatus;
  SZWaveGeneric8bStatus         AreNodesNeighborStatus;
  SZWaveGeneric8bStatus         IsFailedNodeIDStatus;
  SZWaveGeneric8bStatus         ReplaceFailedNodeStatus;
  SZWaveGetRoutingInfoStatus    GetRoutingInfoStatus;
  SZWaveGeneric8bStatus         SetRoutingInfoStatus;
  SZWaveGeneric8bStatus         StoreNodeInfoStatus;
  SZWaveGetPriorityRouteStatus  GetPriorityRouteStatus;
  SZWaveSetPriorityRouteStatus  SetPriorityRouteStatus;
  SZWaveGeneric8bStatus         SetSlaveLearnModeStatus;
  SZWaveGeneric8bStatus         IsVirtualNodeStatus;
  SZWaveGetVirtualNodesStatus   GetVirtualNodesStatus;
  SZWaveGeneric8bStatus         GetControllerCapabilitiesStatus;
  SZWaveGeneric8bStatus         IsPrimaryCtrlStatus;
  SZWaveAesEcbStatus            AesEcbStatus;
  SZWaveGetBackgroundRssiStatus GetBackgroundRssiStatus;
  SZWaveNetworkManagementStatus NetworkManagementStatus;
  SZWaveGeneric8bStatus         FailedNodeIDStatus;
  SNvmBackupRestoreStatus       NvmBackupRestoreStatus;
  SZWaveGenericBoolStatus       SetPowerDownCallbackStatus;
  SZWaveGetIncludedNodes        GetIncludedNodes;
  SZWaveGetIncludedNodesLR      GetIncludedNodesLR;
  SZWaveGeneric8bStatus         RequestNodeNeigborUpdateStatus;
  SZWaveGeneric8bStatus         RequestNodeTypeNeigborUpdateStatus;
  SZWaveGeneric8bStatus         InitiateShutdownStatus;
  SZWaveGeneric8bStatus         GetLRChannel;
  SZWaveGeneric8bStatus         SetLRChannel;
  SZWaveGeneric8bStatus         GetPTIconfig;
  SZWaveGenericBoolStatus       SetTxAttenuation;
  SZWaveTxPowerMaxSupported     GetTxPowerMaximumSupported;
} UCommandStatus;
 
typedef union UReceiveCmdPayload
{
  ZW_APPLICATION_TX_BUFFER rxBuffer;
  uint8_t padding[ZW_MAX_PAYLOAD_SIZE];
} UReceiveCmdPayload;
 
typedef union UCommandParameters
{
  SCommandGenerateRandom              GenerateRandom;
  SCommandNodeInfo                    NodeInfo;
  SCommandClearNetworkStatistics      ClearNetworkStatistics;
  SCommandSetLearnMode                SetLearnMode;
  SCommandSetSmartStartLearnMode      SetSmartStartLearnMode;
  SCommandSetPromiscuousMode          SetPromiscuousMode;
  SCommandSetRfReceiveMode            SetRfReceiveMode;
  SCommandGeniric8bParameter          IsNodeWithinDirectRange;
  SCommandGeniric8bParameter          GetNeighborCount;
  SCommandAreNodesNeighbours          AreNodesNeighbours;
  SCommandNetworkManagement           IsFailedNodeID;
  SCommandNetworkManagement           SetSlaveLearnMode;
  SCommandGetRoutingInfo              GetRoutingInfo;
  SCommandSetRoutingInfo              SetRoutingInfo;
  SCommandStoreNodeInfo               StoreNodeInfo;
  SCommandStoreHomeID                 StoreHomeID;
  SCommandGeniric8bParameter          LockRouteResponse;
  SCommandGetPriorityRoute            GetPriorityRoute;
  SCommandSetPriorityRoute            SetPriorityRoute;
  SCommandGeniric16bParameter         IsVirtualNode;
  SCommandGeniric8bParameter          SetRoutingMax;
  SCommandNetworkManagement           NetworkManagement;
  SCommandNetworkManagementDSK        NetworkManagementDSK;
  SCommandFailedNodeIDCmd             FailedNodeIDCmd;
  SCommandAesEcb                      AesEcb;
  SCommandPMSetPowerDownCallback      PMSetPowerDownCallback;
  SCommandGeniric8bParameter          UpdateCtrlNodeInformation;
  SCommandSetLBTThreshold             SetLBTThreshold;
  SCommandSetRfPowerLevel             SetRfPowerLevel;
  SCommandSetMaxInclReqInterval       SetMaxInclReqInterval;
  SCommandNvmBackupRestore            NvmBackupRestore;
  SCommandSetSecurityKeys             SetSecurityKeys;
  SCommandRequestNodeNeighborUpdate   RequestNodeNeighborUpdate;
  SCommandRequestNodeTypeNeighborUpdate   RequestNodeTypeNeighborUpdate;
  SCommandInitiateShutdown            InitiateShutdown;
  SCommandGeniric8bParameter          SetLRChannel;
  SCommandGeniric8bParameter          SetLRVirtualNodeIDs;
  SCommandGeniric8bParameter          SetTxAttenuation;
  SCommandSetSecurityFlags            SetSecurityFlags;
} UCommandParameters;
 
/**************************************************************************
 * Due to forward declaration issue, these structures and unions
 * must be placed here. They are all dependent on the unions above.
 *************************************************************************/
 
typedef struct SZwaveTransmitPackage
{
  EZwaveTransmitType eTransmitType;
  UTransmitParameters uTransmitParams;
} SZwaveTransmitPackage;
 
typedef struct SZwaveCommandStatusPackage
{
  EZwaveCommandStatusType eStatusType;
  UCommandStatus Content;
} SZwaveCommandStatusPackage;
 
typedef struct SZwaveCommandPackage
{
  EZwaveCommandType eCommandType;
  UCommandParameters uCommandParams;
} SZwaveCommandPackage;
 
// Receive structures ------------------------------
 
typedef struct SReceiveSingle
{
  UReceiveCmdPayload Payload;
  uint8_t iLength;
  RECEIVE_OPTIONS_TYPE RxOptions;
} SReceiveSingle;
 
typedef struct SReceiveMulti
{
  NODE_MASK_TYPE NodeMask;
  UReceiveCmdPayload Payload;
  uint8_t iCommandLength;
  RECEIVE_OPTIONS_TYPE RxOptions;
} SReceiveMulti;
 
// This one union is dependent on the structures above it.
typedef union UReceiveParameters
{
  SReceiveSingle Rx;
  SReceiveMulti RxMulti;
  SReceiveNodeUpdate RxNodeUpdate;
  SReceiveSecurityEvent RxSecurityEvent;
} UReceiveParameters;
 
typedef struct SZwaveReceivePackage
{
  EZwaveReceiveType eReceiveType;
  UReceiveParameters uReceiveParams;
} SZwaveReceivePackage;
 
 
// Each item type to be put on queues between app and protocol, has been given a value range for ID enums.
// They do not overlap, as this makes it easy to detect if an item has errournously been put on the wrong queue.
STATIC_ASSERT(NUM_EZWAVETRANSMITTYPE < (APPLICATION_INTERFACE_TRANSMIT_ENUM_OFFSET + (APPLICATION_INTERFACE_COMMAND_ENUM_OFFSET)),
    STATIC_ASSERT_FAILED_interface_tx_enum_overlap);
STATIC_ASSERT(NUM_EZWAVECOMMANDTYPE < (APPLICATION_INTERFACE_COMMAND_ENUM_OFFSET + (APPLICATION_INTERFACE_RECEIVE_ENUM_OFFSET)),
    STATIC_ASSERT_FAILED_interface_command_enum_overlap);
STATIC_ASSERT(NUM_EZWAVERECEIVETYPE < (APPLICATION_INTERFACE_RECEIVE_ENUM_OFFSET + (APPLICATION_INTERFACE_STATUS_ENUM_OFFSET)),
    STATIC_ASSERT_FAILED_interface_receive_enum_overlap);
STATIC_ASSERT(NUM_EZWAVECOMMANDSTATUS < (APPLICATION_INTERFACE_STATUS_ENUM_OFFSET + 0x40),
    STATIC_ASSERT_FAILED_interface_status_enum_overlap);
 
 
#endif /* _ZW_APPLICATION_TRANSPORT_INTERFACE_H_ */