zdo.h

Go to the documentation of this file.

#ifndef _ZDO_H
#define _ZDO_H

#include <macAddr.h>
#include <appFramework.h>
#include <aps.h>
#include <configServer.h>

#define ZDP_REQUEST_MASK  0x7FFF
#define ZDP_RESPONSE_MASK 0x8000

#ifdef _SECURITY_
#define PRECONFIGURED_NETWORK_KEY 0
#define PRECONFIGURED_TRUST_CENTER_LINK_KEY 1
#define PRECONFIGURED_TRUST_CENTER_MASTER_KEY 2
#define NOT_PRECONFIGURED 3

#ifndef ZDO_SECURITY_STATUS
#define ZDO_SECURITY_STATUS NOT_PRECONFIGURED 
#endif //ZDO_SECURITY_STATUS 


#define ZDO_NONE_SECURITY_MODE     0
#define ZDO_STANDARD_SECURITY_MODE 1
#define ZDO_HIGH_SECURITY_MODE     2
#endif//_SECURITY_

#define MAX_REQUESTED_CLUSTER_NUMBER 9
#define MAX_ACTIVE_EP_NUMBER 3

typedef enum 
{
  LEAVED_BY_PARENT,
  LINK_FAIL,
  LEAVE_REQ
} NetLostReason_t;

typedef enum 
{
  ZDO_SUCCESS_STATUS                = 0x00, 
  ZDO_INVALID_PARAMETERS_STATUS     = 0x01, 
  ZDO_NOT_PERMITTED_STATUS          = 0x03, 
  ZDO_BUSY_STATUS                   = 0x04,
  ZDO_NO_NETWORKS_STATUS            = 0x05,
  ZDO_EXTPANID_ALREADY_EXIST_STATUS = 0x06,
  ZDO_FAIL_STATUS                   = 0x07,
  ZDO_AUTHENTICATION_SUCCESS_STATUS = 0x08,
  ZDO_AUTHENTICATION_FAIL_STATUS    = 0x09,
  ZDO_SECURITY_SUCCESS_STATUS       = 0x0A,
  ZDO_SECURITY_FAIL_STATUS          = 0x0B,
  ZDO_SECURITY_NOT_SUPPORTED_STATUS = 0x0C,
  ZDO_CMD_COMPLETED_STATUS          = 0x0D,
  ZDO_INVALID_REQUEST_STATUS        = 0x80,
  ZDO_DEVICE_NOT_FOUND_STATUS       = 0x81,  
  ZDO_INVALID_EP_STATUS             = 0x82,
  ZDO_NOT_ACTIVE_STATUS             = 0x83,
  ZDO_NOT_SUPPORTED_STATUS          = 0x84,
  ZDO_TIMEOUT_STATUS                = 0x85,
  ZDO_NO_MATCH_STATUS               = 0x86,
  ZDO_NO_ENTRY_STATUS               = 0x88,
  ZDO_NO_DESCRIPTOR_STATUS          = 0x89,
  ZDO_INSUFFICIENT_SPACE_STATUS     = 0x8A,
  ZDO_RESPONSE_WAIT_TIMEOUT_STATUS  = 0x8B,
  ZDO_TABLE_FULL_STATUS             = 0x8C,
  ZDO_NOT_AUTHORIZED_STATUS         = 0x8D,
  ZDO_NWK_UPDATE_STATUS             = 0x8E,
  ZDO_NETWORK_STARTED_STATUS        = 0x8F,
  ZDO_NETWORK_LOST_STATUS           = 0x90,
  ZDO_REJOIN_STARTED_STATUS         = 0x91,
  ZDO_NETWORK_LEFT_STATUS              = 0x92,
} ZDO_Status_t;

enum 
{
  SINGLE_RESPONSE_REQUESTTYPE   = 0x00,
  EXTENDED_RESPONSE_REQUESTTYPE = 0x01
};

typedef enum 
{
//Device and Service Discovery commands
  NWK_ADDR_CLID                = 0x0000,
  IEEE_ADDR_CLID               = 0x0001,
  NODE_DESCRIPTOR_CLID         = 0x0002,
  POWER_DESCRIPTOR_CLID        = 0x0003,
  SIMPLE_DESCRIPTOR_CLID       = 0x0004,
  ACTIVE_ENDPOINTS_CLID        = 0x0005,
  MATCH_DESCRIPTOR_CLID        = 0x0006,
  COMPLEX_DESCRIPTOR_CLID      = 0x0010,
  USER_DESCRIPTOR_CLID         = 0x0011,
  DISCOVERY_CASH_CLID          = 0x0012,
  DEVICE_ANNCE_CLID            = 0x0013,
  USER_DESC_CONF_CLID          = 0x0014,
  SYSTEM_SERVER_DISCOVERY_CLID = 0x0015,
  DISCOVERY_STORE_CLID         = 0x0016,
  NODE_DESC_STORE_CLID         = 0x0017,
  POWER_DESC_STORE_CLID        = 0x0018,
  ACTIVE_EP_STORE_CLID         = 0x0019,
  SIMPLE_DESC_STORE_CLID       = 0x001A,
  REMOVE_NODE_CACHE_CLID       = 0x001B,
  FIND_NODE_CACHE_CLID         = 0x001C,
  EXTENDED_SIMPLE_DESC_CLID    = 0x001D,
  EXTENDED_ACTIVE_EP_CLID      = 0x001E,
// Bind client manager commands
  END_DEVICE_BIND_CLID         = 0x0020,
  BIND_CLID                    = 0x0021,
  UNBIND_CLID                  = 0x0022,
  BIND_REGISTER_CLID           = 0x0023,
  REPLACE_DEVICE_CLID          = 0x0024,
  STORE_BCKUP_BIND_ENTRY_CLID  = 0x0025,
  REMOVE_BCKUP_BIND_ENTRY_CLID = 0x0026,
  BACKUP_BIND_TABLE_CLID       = 0x0027,
  RECOVER_BIND_TABLE_CLID      = 0x0028,
  BACKUP_SOURCE_BIND_CLID      = 0x0029,
  RECOVER_SOURCE_BIND_CLID     = 0x002A,
// Network Management Client Services commands
  MGMT_NWK_DISC_CLID           = 0x0030,
  MGMT_LQI_CLID                = 0x0031,
  MGMT_RTG_CLID                = 0x0032,
  MGMT_BIND_CLID               = 0x0033,
  MGMT_LEAVE_CLID              = 0x0034,
  MGMT_DIRECT_JOIN_CLID        = 0x0035,
  MGMT_PERMIT_JOINING_CLID     = 0x0036,
  MGMT_CACHE_CLID              = 0x0037,
  MGMT_NWK_UPDATE_CLID         = 0x0038
} ZDO_ZdpClusterId_t;

typedef enum 
{
  SHORT_ADDR_MODE,
  EXT_ADDR_MODE
} AddrMode_t;

/********************************************************************************/
typedef struct
{
  uint8_t       activeChannel; 
  ShortAddr_t   shortAddr;     
  PanId_t       PANId;         
  uint64_t      extPANId;      
  ShortAddr_t   parentAddr;    
  ZDO_Status_t  status;        
} PACK ZDO_StartNetworkConf_t;

/********************************************************************************/
typedef struct PACK
{
  ZDO_StartNetworkConf_t confParams;  
  void (*ZDO_StartNetworkConf)(ZDO_StartNetworkConf_t *conf); 
} ZDO_StartNetworkReq_t;

/********************************************************************************/
typedef struct PACK
{
  ZDO_Status_t  status; 
} ZDO_ResetNetworkConf_t;

/********************************************************************************/
typedef struct PACK
{
  ZDO_ResetNetworkConf_t confParams;    
  void (*ZDO_ResetNetworkConf)(ZDO_ResetNetworkConf_t *conf); 
} ZDO_ResetNetworkReq_t;

typedef struct PACK
{
  uint32_t        scannedChannels;
  uint16_t        totalTransmissions;
  uint16_t        transmissionsFailures;
  uint8_t         scannedChannelsListCount;
  uint8_t         energyValues[32];//TODO  
} EDScan_t;

typedef struct PACK
{
  ShortAddr_t parentShortAddr;
  PanId_t     panId;
  uint8_t     currentChannel;
  ShortAddr_t shortAddr;
} NetworkInf_t;

typedef struct PACK
{
//  ZDO_Status_t    status;
  uint8_t status;
  union
  {
    EDScan_t     scanResult;
    NetworkInf_t nwkUpdateInf;  
  };
} ZDO_MgmtNwkUpdateNotf_t;

typedef struct PACK
{
  ZDO_Status_t status;
} ZDO_SleepConf_t;

typedef struct PACK
{
  ZDO_SleepConf_t confirm;
  void (*ZDO_SleepConf)(ZDO_SleepConf_t *conf);
} PACK ZDO_SleepReq_t;

typedef struct PACK
{
  ZDO_Status_t status; 
} PACK ZDO_WakeUpConf_t;

typedef struct PACK
{
  ZDO_WakeUpConf_t confirm;
  void (*ZDO_WakeUpConf)(ZDO_WakeUpConf_t *conf);
} PACK ZDO_WakeUpReq_t;

typedef struct PACK
{
  ExtAddr_t ieeeAddrOfInterest;
  uint8_t   reqType;
  uint8_t   startIndex;
} ZDO_NwkAddrReq_t;

typedef struct PACK
{
  ShortAddr_t nwkAddrOfInterest;
  uint8_t reqType;
  uint8_t startIndex;
} ZDO_IeeeAddrReq_t;

typedef struct PACK
{
  ShortAddr_t nwkAddrOfInterest;
} ZDO_NodeDescReq_t;

typedef struct PACK
{
  ShortAddr_t nwkAddrOfInterest;
} ZDO_PowerDescReq_t;

typedef struct PACK
{
  ShortAddr_t nwkAddrOfInterest;
} ZDO_ActiveEPReq_t;

typedef struct PACK
{
  ShortAddr_t nwkAddrOfInterest;
} ZDO_ComplexDescReq_t;

typedef struct PACK
{
  ShortAddr_t nwkAddrOfInterest;
} ZDO_UserDescReq_t;

typedef struct PACK
{
  ShortAddr_t nwkAddrOfInterest;
} ZDO_UserDescSetReq_t;

typedef struct PACK
{
  ShortAddr_t nwkAddrOfInterest;
  Endpoint_t  endpoint;
} ZDO_SimpleDescReq_t;

typedef struct PACK
{
  ShortAddr_t nwkAddrLocal;
  ExtAddr_t   ieeeAddrLocal;
  uint8_t     macCapability;
} ZDO_DeviceAnnceReq_t;

typedef struct PACK
{
  uint16_t serverMask;
} ZDO_SystemServerDiscoveryReq_t;

#ifdef _BINDING_
typedef struct PACK
{
  ShortAddr_t nwkAddrOfInterest;
  ProfileId_t profileId;
  uint8_t     numInClusters;
  ClusterId_t inClusterList[MAX_REQUESTED_CLUSTER_NUMBER];
  uint8_t     numOutClusters;
  ClusterId_t outClusterList[MAX_REQUESTED_CLUSTER_NUMBER];  
} ZDO_MatchDescReq_t;
#endif // _BINDING_

typedef struct PACK
{
  ExtAddr_t deviceAddr;
  uint8_t   reserved : 6;
  uint8_t   removeChildren : 1;
  uint8_t   rejoin : 1;
} ZDO_MgmtLeaveReq_t;

typedef struct PACK
{
  uint8_t permitDuration;
  uint8_t tcSignificance;
} ZDO_MgmtPermitJoiningReq_t;

typedef struct PACK
{
  uint32_t    scanChannels;
  uint8_t     scanDuration;
  union
  {
    uint8_t     scanCount;
    uint8_t     nwkUpdateId;
  };
  ShortAddr_t nwkManagerAddr;
} ZDO_MgmtNwkUpdateReq_t;

typedef struct PACK
{
  ExtAddr_t   ieeeAddrRemote;
  ShortAddr_t nwkAddrRemote;
  uint8_t     numAssocDev;
  uint8_t     startIndex;
  ShortAddr_t nwkAddrAssocDevList[CS_MAX_CHILDREN_AMOUNT];
} ZDO_NwkAddrResp_t;

typedef struct PACK
{
  ExtAddr_t   ieeeAddrRemote;
  ShortAddr_t nwkAddrRemote;
  uint8_t     numAssocDev;
  uint8_t     startIndex;
  ShortAddr_t nwkAddrAssocDevList[CS_MAX_CHILDREN_AMOUNT];
} ZDO_IeeeAddrResp_t;

typedef struct PACK
{
  ShortAddr_t      nwkAddrOfInterest;
  NodeDescriptor_t nodeDescriptor;
} ZDO_NodeDescResp_t;

typedef struct PACK
{
  ShortAddr_t       nwkAddrOfInterest;
  PowerDescriptor_t powerDescriptor;
} ZDO_PowerDescResp_t;

typedef struct PACK
{
  ShortAddr_t      nwkAddrOfInterest;
} ZDO_ComplexDescResp_t;

typedef struct PACK
{
  ShortAddr_t      nwkAddrOfInterest;
} ZDO_UserDescResp_t;

typedef struct PACK
{
  ShortAddr_t      nwkAddrOfInterest;
} ZDO_UserDescConfResp_t;

typedef struct PACK
{
  ShortAddr_t nwkAddrOfInterest;
  uint8_t     activeEPCount;
  uint8_t     activeEPList[MAX_ACTIVE_EP_NUMBER];
} ZDO_ActiveEPResp_t;

typedef struct PACK
{
  Endpoint_t   endpoint;
  ProfileId_t  AppProfileId;
  uint16_t     AppDeviceId;
  uint8_t      AppDeviceVersion : 4;
  uint8_t      Reserved         : 4;
  uint8_t      AppInClustersCount;
  ClusterId_t  AppInClustersList[MAX_REQUESTED_CLUSTER_NUMBER];
  uint8_t      AppOutClustersCount;
  ClusterId_t  AppOutClustersList[MAX_REQUESTED_CLUSTER_NUMBER];

} ZdpSimpleDescriptor_t;

typedef struct PACK
{
  ShortAddr_t           nwkAddrOfInterest;
  uint8_t               length;
  ZdpSimpleDescriptor_t simpleDescriptor;
} ZDO_SimpleDescResp_t;

typedef struct PACK
{
  uint16_t      serverMask;
} ZDO_SystemServerDiscoveryResp_t;

#ifdef _BINDING_
typedef struct PACK
{
  ShortAddr_t nwkAddrOfInterest;
  uint8_t     matchLength;
  uint8_t     matchList[MAX_REQUESTED_CLUSTER_NUMBER];
} ZDO_MatchDescResp_t;
#endif // _BINDING_

typedef struct PACK
{
  uint8_t seqNum;
  // user part
  uint8_t status;
  union
  {
    ZDO_NwkAddrResp_t               nwkAddrResp;
    ZDO_IeeeAddrResp_t              ieeeAddrResp;
    ZDO_NodeDescResp_t              nodeDescResp;
    ZDO_PowerDescResp_t             powerDescResp;
    ZDO_SimpleDescResp_t            simpleDescResp;
    ZDO_ComplexDescResp_t           complexDescResp;
    ZDO_UserDescResp_t              userDescResp;
    ZDO_ActiveEPResp_t              activeEPResp;
    ZDO_UserDescConfResp_t          userDescConfResp;
    ZDO_SystemServerDiscoveryResp_t systemServerDiscoveryResp;
#ifdef _BINDING_    
    ZDO_MatchDescResp_t             matchDescResp;
#endif // _BINDING_    
    ZDO_MgmtNwkUpdateNotf_t         mgmtNwkUpdateNotf;
  };
} ZDO_ZdpRespFrame_t;

typedef struct PACK
{
  uint8_t seqNum;
  // user part
  union
  {
    ZDO_NwkAddrReq_t               nwkAddrReq;
    ZDO_IeeeAddrReq_t              ieeeAddrReq;
    ZDO_NodeDescReq_t              nodeDescReq;
    ZDO_PowerDescReq_t             powerDescReq;
    ZDO_SimpleDescReq_t            simpleDescReq;
    ZDO_DeviceAnnceReq_t           deviceAnnce;
    ZDO_ActiveEPReq_t              activeEPReq;
    ZDO_ComplexDescReq_t           complexDescReq;
    ZDO_UserDescReq_t              userDescReq;
    ZDO_UserDescSetReq_t           userDescSetReq;
    ZDO_SystemServerDiscoveryReq_t systemServerDiscoveryReq;
#ifdef _BINDING_
    ZDO_MatchDescReq_t             matchDescReq;
#endif // _BINDING_    
    ZDO_MgmtLeaveReq_t             mgmtLeaveReq;
    ZDO_MgmtPermitJoiningReq_t     mgmtPermitJoiningReq;
    ZDO_MgmtNwkUpdateReq_t         mgmtNwkUpdateReq;
    ZDO_MgmtNwkUpdateNotf_t        mgmtNwkUpdateNotf;
  };  
} ZDO_ZdpReqFrame_t;

typedef struct PACK
{
  // reserved
  uint8_t       header[APS_ASDU_OFFSET];
  union
  {
    ZDO_ZdpRespFrame_t respPayload;
    ZDO_ZdpReqFrame_t  reqPayload; 
  };
} ZDO_ZdpFrame_t;

typedef struct
{
  AddrMode_t     srcAddrMode;
  union
  {
    ShortAddr_t  srcNwkAddr;
    ExtAddr_t    srcExtAddr;
  };
  ZDO_ZdpRespFrame_t respPayload;  
} ZDO_ZdpResp_t;

typedef struct PACK
{
  // Service fields
  struct 
  {
    void *next;
  } service;
  
  // Address fields
  ZDO_ZdpClusterId_t reqCluster;
  AddrMode_t         dstAddrMode;
  
  union
  {
    ShortAddr_t  dstNwkAddr;
    ExtAddr_t    dstExtAddr;
  };
  
  // zdp frame for sending out
  ZDO_ZdpFrame_t req;
  
  //Callback and Response
  void (*ZDO_ZdpResp)(ZDO_ZdpResp_t *zdpResp);
  ZDO_ZdpResp_t resp;
  
} ZDO_ZdpReq_t;

typedef struct PACK
{
  ShortAddr_t shortAddr;
  ExtAddr_t   extAddr;  
} NodeAddr_t;

/********************************************************************************/
typedef struct PACK
{
  ShortAddr_t  nodeAddr; 
  ZDO_Status_t status; 
  uint8_t      lqi; 
  uint8_t      rssi; 
} ZDO_GetLqiRssi_t;

/********************************************************************************/
typedef struct
{
  uint8_t childrenCount; 
  NodeAddr_t *childrenTable; 
} ZDO_GetChildrenAddr_t;

/********************************************************************************/
typedef struct
{
  ZDO_Status_t status; 
} ZDO_SetTxPowerConf_t;

/********************************************************************************/
typedef struct 
{
  uint8_t txPower; 
  void (* ZDO_SetTxPowerConf)(ZDO_SetTxPowerConf_t *conf); 
  ZDO_SetTxPowerConf_t confirm; 
} ZDO_SetTxPowerReq_t;

/********************************************************************************/
typedef enum
{
  ZDO_IN_NETWORK_STATUS, 
  ZDO_OUT_NETWORK_STATUS 
} ZDO_NwkStatus_t;

typedef struct PACK 
{
  ZDO_Status_t status;
} ZDO_EndToEndAppKeyConf_t;

typedef struct PACK 
{
  ExtAddr_t deviceAddr;
  void (*ZDO_EndToEndAppKeyConf)(ZDO_EndToEndAppKeyConf_t *conf);
  ZDO_EndToEndAppKeyConf_t confirm;
} ZDO_EndToEndAppKeyReq_t;

/************************************************************************************
  Primitives declarations.
 ***********************************************************************************/

/*********************************************************************************/
void ZDO_StartNetworkReq(ZDO_StartNetworkReq_t *startingParams);

/**********************************************************************************/
void ZDO_ResetNetworkReq(ZDO_ResetNetworkReq_t *resetParams);

/**********************************************************************************/
void ZDO_MgmtNwkUpdateNotf(ZDO_MgmtNwkUpdateNotf_t * nwkParams);

/*************************************************************************************/
void ZDO_SleepReq(ZDO_SleepReq_t *req);

/**************************************************************************************/
void ZDO_SleepInd(void);

/*************************************************************************************/
void ZDO_SleepResp(void);

/*************************************************************************************/
void ZDO_WakeUpInd(void);

/*************************************************************************************/
void ZDO_WakeUpReq(ZDO_WakeUpReq_t *req);

void ZDO_ZdpReq(ZDO_ZdpReq_t *zdpReq);

/*************************************************************************************/
void ZDO_GetLqiRssi(ZDO_GetLqiRssi_t *lqiRssi);

/*************************************************************************************/
void ZDO_GetParentAddr(NodeAddr_t *parentAddr);

/*************************************************************************************/
void ZDO_GetChildrenAddr(ZDO_GetChildrenAddr_t *childrenAddr);

/*************************************************************************************/
void ZDO_SetTxPowerReq(ZDO_SetTxPowerReq_t *req);

/*************************************************************************************/
ZDO_NwkStatus_t ZDO_GetNwkStatus();

#endif  /* _ZDO_H */

---