aps.h

Go to the documentation of this file.

/*************************************************************************/
#ifndef _APS_H
#define _APS_H

/******************************************************************************
                   Includes section
******************************************************************************/
#include <types.h>
#include <nwk.h>
#include <appFramework.h>
#include <macAddr.h>


/******************************************************************************
                   Define(s) section
******************************************************************************/

// \cond internal
#ifndef APS_MAX_TRANSMISSION_WINDOW_SIZE  
#define APS_MAX_TRANSMISSION_WINDOW_SIZE        3
#endif
// \endcond

// \cond internal
#ifndef APS_MAX_BLOCKS_AMOUNT
#define APS_MAX_BLOCKS_AMOUNT                   3
#endif
// \endcond



/*****************************************************************************
  APDU Frame 
*****************************************************************************/  
//APS APDU Max Header size
#ifndef _HIGH_SECURITY_
#define APS_MAX_DATA_FRAME_HEADER_LENGTH  12

//APS APDU Max Footer size
#define APS_MAX_DATA_FRAME_FOOTER_LENGTH  0
#else
#define APS_MAX_DATA_FRAME_HEADER_LENGTH  (12 + 6) /*6 bytes - auxiliary header*/

//APS APDU Max Footer size
#define APS_MAX_DATA_FRAME_FOOTER_LENGTH  8        /*8 bytes - Message Integrity Code (MIC)*/
#endif


#define APS_AFFIX_LENGTH                  (APS_MAX_DATA_FRAME_HEADER_LENGTH + APS_MAX_DATA_FRAME_FOOTER_LENGTH + NWK_AFFIX_LENGTH)

#define APS_MAX_ASDU_SIZE                 (NWK_MAX_NSDU_SIZE - APS_MAX_DATA_FRAME_HEADER_LENGTH - APS_MAX_DATA_FRAME_FOOTER_LENGTH)

#define APS_ASDU_OFFSET                   (NWK_NSDU_OFFSET + APS_MAX_DATA_FRAME_HEADER_LENGTH)



/*****************************************************************************
  APS endpoints defines
*****************************************************************************/  

//APS Broadcast Endpoint
#define APS_BROADCAST_ENDPOINT      0xff

//ZDO Endpoint
#define APS_ZDO_ENDPOINT            0x00

//User endpoints
#define APS_MIN_USER_ENDPOINT       0x01
#define APS_MAX_USER_ENDPOINT       0xf0

//Reserved endpoints
#define APS_MIN_RESERVED_ENDPOINT   0xf1
#define APS_MAX_RESERVED_ENDPOINT   0xfe
//============================================================================


/*****************************************************************************
  APS short address defines
*****************************************************************************/ 
#define APS_MAX_UNICAST_SHORT_ADDRESS     0xfff7



/******************************************************************************
                   Types section
******************************************************************************/


/*****************************************************************************
  Special APS Level data types definition
*****************************************************************************/

/*************************************************************************/
typedef union
{
  ShortAddr_t shortAddress; 
#ifdef _APS_MULTICAST_
  GroupAddr_t groupAddress; 
#endif                            // 
  ExtAddr_t extAddress;     
} APS_Address_t;



/*************************************************************************/
typedef enum
{
  APS_NO_ADDRESS                          = 0x00,   
#ifdef _APS_MULTICAST_ 
  APS_GROUP_ADDRESS                       = 0x01,   
#endif 
  APS_SHORT_ADDRESS                       = 0x02,   
  APS_EXT_ADDRESS                         = 0x03    
} APS_AddrMode_t;

/*************************************************************************/
typedef enum
{
  APS_SUCCESS_STATUS                      = 0x00,   
  APS_ASDU_TOO_LONG_STATUS                = 0xa0,   
  APS_DEFRAG_DEFERRED_STATUS              = 0xa1,   
  APS_DEFRAG_UNSUPPORTED_STATUS           = 0xa2,   
  APS_ILLEGAL_REQUEST_STATUS              = 0xa3,   
  APS_INVALID_BINDING_STATUS              = 0xa4,   
  APS_INVALID_GROUP_STATUS                = 0xa5,   
  APS_INVALID_PARAMETER_STATUS            = 0xa6,   
  APS_NO_ACK_STATUS                       = 0xa7,   
  APS_NO_BOUND_DEVICE_STATUS              = 0xa8,   
  APS_NO_SHORT_ADDRESS_STATUS             = 0xa9,   
  APS_NOT_SUPPORTED_STATUS                = 0xaa,   
  APS_SECURED_LINK_KEY_STATUS             = 0xab,   
  APS_SECURED_NWK_KEY_STATUS              = 0xac,   
  APS_SECURITY_FAIL_STATUS                = 0xad,   
  APS_TABLE_FULL_STATUS                   = 0xae,   
  APS_UNSECURED_STATUS                    = 0xaf,   
  APS_UNSUPPORTED_ATTRIBUTE_STATUS        = 0xb0,   
  
  //Proprietary status values
  APS_NOT_INDICATED_STATUS                = 0xb1    
} APS_Status_t;

#ifdef _SECURITY_
/*************************************************************************/
typedef enum
{
  APS_SKKE_SUCCESS_STATUS             = 0x00,   
  APS_SKKE_INVALID_PARAMETER_STATUS   = 0x01,   
  APS_SKKE_NO_MASTER_KEY_STATUS       = 0x02,   
  APS_SKKE_INVALID_CHALLENGE_STATUS   = 0x03,   
  APS_SKKE_INVALID_SKG_STATUS         = 0x04,   
  APS_SKKE_INVALID_MAC_STATUS         = 0x05,   
  APS_SKKE_INVALID_KEY_STATUS         = 0x06,   
  APS_SKKE_TIMEOUT_STATUS             = 0x07,   
  APS_SKKE_BAD_FRAME_STATUS           = 0x08,   
} APS_SkkeStatus_t;
#endif //#ifdef _SECURITY_

/*************************************************************************/
typedef enum
{
  //AIB standard attributes
  APS_AIB_BINDING_TABLE                   = 0xc1,   
  APS_AIB_DESIGNATED_COORDINATOR          = 0xc2,   
  APS_AIB_CHANNEL_MASK                    = 0xc3,   
  APS_AIB_USE_EXTENDED_PANID              = 0xc4,   
  APS_AIB_GROUP_TABLE                     = 0xc5,   
  APS_AIB_NONMEMBER_RADIUS                = 0xc6,   
  APS_AIB_PERMISSIONS_CONFIGURATION       = 0xc7,   
  APS_AIB_USE_INSECURE_JOIN               = 0xc8,   
  APS_AIB_INTERFRAME_DELAY                = 0xc9,   

  //AIB security attributes ID
  APS_AIB_DEVICE_KEY_PAIR_SET             = 0xaa,   
  APS_AIB_TRUST_CENTER_ADDRESS            = 0xab,   
  APS_AIB_SECURITY_TIME_OUT_PERIOD        = 0xac    
} APS_AibAttributeId_t;

/*************************************************************************/
typedef struct
{
  uint8_t   apscMaxDescriptorSize;                    
  uint8_t   apscMaxFrameRetries;                      
  uint32_t  apscAckWaitDuration;                      
  uint8_t   apscMinDuplicateRejectionTableSize;       
  uint8_t   apscMaxWindowSize;                        
  uint16_t  apscInterframeDelay;                      
  uint8_t   apscMinHeaderOverHead;                    
} PACK APS_AibPermissionsConfiguration_t;               



/*****************************************************************************
  APS Group Table entry type
*****************************************************************************/
typedef struct
{
  bool busy;    
  GroupAddr_t groupAddr;              //Group address 
  Endpoint_t endpoints[1];            //endpoints (group members)
} PACK APS_GroupTableEntry_t;

/*****************************************************************************
  APS Group Table type
*****************************************************************************/
typedef struct
{
  uint8_t   groupsAmount;             //Table size in cells (amount of entries)
  uint8_t   endpointsAmount;          //Maximum amount of group members 
                                      //(positive value)
  uint16_t  entrySizeof;              //Entry size in bytes
  APS_GroupTableEntry_t *entries;     //Table entries buffer pointer
} PACK APS_GroupTable_t;

/*************************************************************************/
typedef union
{
  //AIB standard attributes
  
  void      *apsBindingTable;         
  bool      apsDesignatedCoordinator; 
  uint32_t  apsChannelMask;           
  uint64_t  apsUseExtendedPANID;      
  APS_GroupTable_t *apsGroupTable;    
  uint8_t   apsNonmemberRadius;       
                                       
  APS_AibPermissionsConfiguration_t *apsPermissionsConfiguration;

  bool      apsUseInsecureJoin;       
  uint16_t  apsInterframeDelay;       

  //AIB security attributes
  void      *apsDeviceKeyPairSet;     
  uint64_t  apsTrustCenterAddress;    
  uint16_t  apsSecurityTimeOutPeriod; 
} APS_AibAttribute_t;



/*****************************************************************************
  APSDE Entity Primitives
*****************************************************************************/

/*************************************************************************/
typedef struct
{
  //Standard fields
  //APS_AddrMode_t dstAddrMode;
  //APS_Address_t dstAddress;
  //Endpoint_t dstEndpoint;
  //Endpoint_t srcEndpoint;
  APS_Status_t status;                


  uint32_t txTime;                    
                                      
} PACK APS_DataConf_t;


/*************************************************************************/
typedef struct
{
  uint8_t   securityEnabledTransmission   :1;   
  uint8_t   useNwkKey                     :1;   
  uint8_t   acknowledgedTransmission      :1;   
  uint8_t   fragmentationPermitted        :1;   
  uint8_t   reserved                      :4;   
} PACK APS_TxOptions_t;

/*************************************************************************/
typedef struct
{
  //Service fields
  struct  
  {
    void *next;
  } service;
  
  //Primitive fields
  APS_AddrMode_t dstAddrMode;                   
  APS_Address_t dstAddress;
  Endpoint_t dstEndpoint;
  ProfileId_t profileId;
  ClusterId_t clusterId;
  Endpoint_t srcEndpoint;
  uint8_t asduLength;
  uint8_t *asdu;
  APS_TxOptions_t txOptions;
  uint8_t radius;    
  //Callback and Confirm
  void (*APS_DataConf)(APS_DataConf_t *conf);
  APS_DataConf_t confirm;                       
} PACK APS_DataReq_t;


/*************************************************************************/
typedef struct
{
  APS_AddrMode_t dstAddrMode;
  APS_Address_t dstAddress;
  Endpoint_t dstEndpoint;
  APS_AddrMode_t srcAddrMode;
  APS_Address_t srcAddress;
  Endpoint_t srcEndpoint;
  ProfileId_t profileId;
  ClusterId_t clusterId;
  uint8_t asduLength;
  uint8_t *asdu;
  APS_Status_t status;
  APS_Status_t securityStatus;
  uint8_t linkQuality;
  uint32_t rxTime;
  //\cond internal
  uint8_t rssi;
  //\endcond
} PACK APS_DataInd_t;

//============================================================================

#ifdef _BINDING_
/*****************************************************************************
  Binding Primitives
*****************************************************************************/
//\cond internal
/*
  Parameters structure of the APS_BindConf() function.
  The APSME-BIND.confirm primitive.
*/
typedef struct
{
  //Primitive fields 
  APS_Status_t status;
} PACK APS_BindConf_t;


/*
  Parameters structure of the APS_BindReq() function.
  The APSME-BIND.request primitive.
*/
typedef struct
{
  //Standard fields
  ExtAddr_t srcAddr;
  Endpoint_t srcEndpoint;
  ClusterId_t clusterId;
  APS_AddrMode_t dstAddrMode;
  APS_Address_t dstAddr;
  Endpoint_t dstEndpoint;
  //Confirm
  APS_BindConf_t confirm;
} PACK APS_BindReq_t;


/*
  Parameters structure of the APS_UnbindConf() function.
  The APSME-UNBIND.confirm primitive.
*/
typedef struct
{
  //Standard fields
  APS_Status_t status;
} PACK APS_UnbindConf_t;


/*
  Parameters structure of the APS_UnbindReq_t() function.
  The APSME-UNBIND.request primitive.
*/
typedef struct
{
  //Standard fields
  ExtAddr_t srcAddr;
  Endpoint_t srcEndpoint;
  ClusterId_t clusterId;
  APS_AddrMode_t dstAddrMode;
  APS_Address_t dstAddr;
  Endpoint_t dstEndpoint;
  //Confirm
  APS_UnbindConf_t confirm;
} PACK APS_UnbindReq_t;

//\endcond
#endif //#ifdef _BINDING_

/*****************************************************************************
  AIB Maintenance Primitives
*****************************************************************************/

/*************************************************************************/
typedef struct
{
  //Standard fields
  APS_Status_t status;                     
  uint16_t aibAttributeLength;
  APS_AibAttribute_t aibAttributeValue;
} PACK APS_GetConf_t;


/*************************************************************************/
typedef struct
{
  //Standard fields
  APS_AibAttributeId_t aibAttribute;

  //Confirm
  APS_GetConf_t confirm;
} PACK APS_GetReq_t;


/*************************************************************************/
typedef struct
{
  //Standard fields
  APS_Status_t status;
} PACK APS_SetConf_t;


/*************************************************************************/
typedef struct
{
  //Standard fields
  APS_AibAttributeId_t aibAttribute;
  uint16_t aibAttributeLength;
  APS_AibAttribute_t aibAttributeValue;
  
  //Confirm
  APS_SetConf_t confirm;
} PACK APS_SetReq_t;
//============================================================================

#ifdef _APS_MULTICAST_
/*****************************************************************************
  APS Group Management Primitives
*****************************************************************************/

/*************************************************************************/
typedef struct
{
  //Standard fields
  APS_Status_t status;
} PACK APS_AddGroupConf_t;

/*************************************************************************/
typedef struct
{
  //Standard fields
  GroupAddr_t groupAddress;
  Endpoint_t endpoint;
  
  //Confirm
  APS_AddGroupConf_t confirm;
} PACK APS_AddGroupReq_t;


/*************************************************************************/
typedef struct
{
  //Standard fields
  APS_Status_t status;
} PACK APS_RemoveGroupConf_t;

/*************************************************************************/
typedef struct
{
  //Standard fields
  GroupAddr_t groupAddress;
  Endpoint_t endpoint;
  
  //Confirm
  APS_RemoveGroupConf_t confirm;
} PACK APS_RemoveGroupReq_t;


/*************************************************************************/
typedef struct
{
  //Standard fields
  APS_Status_t status;
} PACK APS_RemoveAllGroupsConf_t;

/*************************************************************************/
typedef struct
{
  //Standard fields
  Endpoint_t endpoint;
  
  //Confirm
  APS_RemoveAllGroupsConf_t confirm;
} PACK APS_RemoveAllGroupsReq_t;
//============================================================================
#endif //#ifdef _APS_MULTICAST_


#ifdef _SECURITY_
#ifdef _HIGH_SECURITY_
typedef struct PACK 
{
  ExtAddr_t deviceAddress;
  uint8_t masterKey[16];
  uint8_t linkKey[16];
  uint32_t outFrameCounter;
  uint32_t inFrameCounter;
} ApsKeyPairDescriptor_t;



/*****************************************************************************
  APS Security Management Primitives
*****************************************************************************/
//\cond internal
typedef enum
{
  APS_SKKE_KEY_ESTABLISHMENT_METHOD = 0x00
} APS_KeyEstablishmentMethod_t;


/*****************************************************************************
  APSME-ESTABLISH-KEY.confirm primitive
*****************************************************************************/
typedef struct
{
  ExtAddr_t address;
  APS_SkkeStatus_t status;
} PACK APS_EstablishKeyConf_t;  



/*****************************************************************************
  APSME-ESTABLISH-KEY.request primitive
*****************************************************************************/
typedef struct
{
  //Service fields
  struct
  {
    void *next;
  } service;
  //Standards fields
  ExtAddr_t responderAddress;
  bool useParent;
  ExtAddr_t responderParentAddress;
  APS_KeyEstablishmentMethod_t keyEstablishmentMethod;
  //Confirm and callback
  APS_EstablishKeyConf_t confirm;
  void (*APS_EstablishKeyConf)(APS_EstablishKeyConf_t *conf);
} PACK APS_EstablishKeyReq_t;
  

/*****************************************************************************
  APSME-ESTABLISH-KEY.response primitive
*****************************************************************************/
typedef struct
{
  ExtAddr_t initiatorAddress;  
  bool accept;
  //Confirm and callback
  APS_EstablishKeyConf_t confirm;
  void (*APS_EstablishKeyConf)(APS_EstablishKeyConf_t *conf);
} PACK APS_EstablishKeyResp_t;  


/*****************************************************************************
  APSME-ESTABLISH-KEY.indication primitive
*****************************************************************************/
typedef struct
{
  //Standards fields
  ExtAddr_t initiatorAddress;  
  APS_KeyEstablishmentMethod_t keyEstablishmentMethod;
} PACK APS_EstablishKeyInd_t;
#endif //#ifdef _HIGH_SECURITY_



//============================================================================
typedef enum
{
  APS_TRUST_CENTER_MASTER_KEY_TYPE =      0x00,
  APS_STANDARD_NETWORK_KEY_TYPE =         0x01,
  APS_APP_MASTER_KEY_TYPE =               0x02,
  APS_APP_LINK_KEY_TYPE =                 0x03,
  APS_TRUST_CENTER_LINK_KEY_TYPE =        0x04,
  APS_HIGH_SECURITY_NETWORK_KEY_TYPE =    0x05
} APS_TransportKeyType_t;  


typedef struct
{
  ExtAddr_t parentAddress;
  uint8_t key[16];
} PACK APS_ReqTrustCenterMasterOrLinkKeyTransportData_t;

typedef struct
{
  uint8_t keySeqNumber;
  uint8_t networkKey[16];
  bool useParent;
  ExtAddr_t parentAddress;
} PACK APS_ReqNetworkKeyTransportData_t;

typedef struct
{
  ExtAddr_t partnerAddress;
  bool initiator;
  uint8_t key[16];
} PACK APS_ReqApplicationMasterOrLinkKeyTransportData_t;

typedef union
{
  APS_ReqTrustCenterMasterOrLinkKeyTransportData_t trustCenterKey;
  APS_ReqNetworkKeyTransportData_t networkKey;
  APS_ReqApplicationMasterOrLinkKeyTransportData_t applicationKey;
} APS_ReqTransportKeyData_t;


typedef enum
{
  APS_TKR_SUCCESS_STATUS                      = 0x00,
  APS_TKR_NO_SHORT_ADDRESS_STATUS             = 0x01,
  APS_TKR_SECURITY_FAIL_STATUS                = 0x02,
  APS_TKR_NOT_SENT_STATUS                     = 0x03
} APS_TkrStatus_t;

/*****************************************************************************
  (Out of ZigBee Standard) APSME-TRANSPORT-KEY.confirm primitive 
*****************************************************************************/
typedef struct PACK
{
  APS_TkrStatus_t status;
} APS_TransportKeyConf_t;

/*****************************************************************************
  APSME-TRANSPORT-KEY.request primitive
*****************************************************************************/
typedef struct
{
  //Service fields
  struct
  {
    void *next;
  } service;

  //Standards fields
  ExtAddr_t destAddress;
  APS_TransportKeyType_t keyType;
  APS_ReqTransportKeyData_t transportKeyData;

  //Callback and Confirm
  APS_TransportKeyConf_t confirm;
  void (*APS_TransportKeyConf)(APS_TransportKeyConf_t *conf);
} PACK APS_TransportKeyReq_t;

//============================================================================

typedef struct
{
  uint8_t trustCenterMasterKey[16];
} PACK APS_IndTrustCenterMasterOrLinkKeyTransportData_t;

typedef struct
{
  uint8_t keySeqNumber;
  uint8_t networkKey[16];
} PACK APS_IndNetworkKeyTransportData_t;

typedef struct
{
  ExtAddr_t partnerAddress;
  uint8_t key[16];
} PACK APS_IndApplicationMasterOrLinkKeyTransportData_t;

typedef union
{
  APS_IndTrustCenterMasterOrLinkKeyTransportData_t trustCenterKey;
  APS_IndNetworkKeyTransportData_t networkKey;
  APS_IndApplicationMasterOrLinkKeyTransportData_t applicationKey;
} APS_IndTransportKeyData_t;  


/*****************************************************************************
  APSME-TRANSPORT-KEY.indication primitive
*****************************************************************************/
typedef struct PACK 
{
  //Standards fields
  ExtAddr_t srcAddress;
  APS_TransportKeyType_t keyType;
  APS_IndTransportKeyData_t transportKeyData;
} APS_TransportKeyInd_t;
//============================================================================

typedef enum
{
  APS_STANDARD_DEVICE_SECURED_REJOIN_STATUS =           0x00,
  APS_STANDARD_DEVICE_UNSECURED_JOIN_STATUS =           0x01,
  APS_DEVICE_LEFT_STATUS =                              0x02,
  APS_STANDARD_DEVICE_UNSECURED_REJOIN_STATUS =         0x03,
  APS_HIGH_SECURITY_DEVICE_SECURED_REJOIN_STATUS =      0x04,
  APS_HIGH_SECURITY_DEVICE_UNSECURED_JOIN_STATUS =      0x05,
  APS_RESERVED_STATUS =                                 0x06,
  APS_HIGH_SECURITY_DEVICE_UNSECURED_REJOIN_STATUS =    0x07
} APS_UpdateDeviceStatus_t;  

typedef enum
{
  APS_UDR_SUCCESS_STATUS                      = 0x00,
  APS_UDR_NO_SHORT_ADDRESS_STATUS             = 0x01,
  APS_UDR_SECURITY_FAIL_STATUS                = 0x02,
  APS_UDR_NOT_SENT_STATUS                     = 0x03
} APS_UdrStatus_t;

/*****************************************************************************
  (Out of ZigBee Standard) APSME-UPDATE-DEVICE.confirm primitive
*****************************************************************************/
typedef struct PACK
{
  APS_UdrStatus_t status;
} APS_UpdateDeviceConf_t;


/*****************************************************************************
  APSME-UPDATE-DEVICE.request primitive
*****************************************************************************/
typedef struct
{
  //Service fields
  struct
  {
    void *next;
  } service;

  //Standards fields
  ExtAddr_t destAddress;
  ExtAddr_t deviceAddress;
  APS_UpdateDeviceStatus_t status;  
  ShortAddr_t deviceShortAddress;

  //Callback and Confirm
  APS_UpdateDeviceConf_t confirm;
  void (*APS_UpdateDeviceConf)(APS_UpdateDeviceConf_t *conf);
} PACK APS_UpdateDeviceReq_t;


/*****************************************************************************
  APSME-UPDATE-DEVICE.indication primitive
*****************************************************************************/
typedef struct
{
  //Standards fields
  ExtAddr_t srcAddress;
  ExtAddr_t deviceAddress;
  APS_UpdateDeviceStatus_t status;  
  ShortAddr_t deviceShortAddress;
} PACK APS_UpdateDeviceInd_t;
//============================================================================

typedef enum
{
  APS_RDR_SUCCESS_STATUS                      = 0x00,
  APS_RDR_NO_SHORT_ADDRESS_STATUS             = 0x01,
  APS_RDR_SECURITY_FAIL_STATUS                = 0x02,
  APS_RDR_NOT_SENT_STATUS                     = 0x03
} APS_RdrStatus_t;

/*****************************************************************************
  (Out of ZigBee Standard) APSME-REMOVE-DEVICE.confirm primitive
*****************************************************************************/
typedef struct PACK
{
  APS_RdrStatus_t status;
} APS_RemoveDeviceConf_t;


/*****************************************************************************
  APSME-REMOVE-DEVICE.request primitive
*****************************************************************************/
typedef struct
{
  //Service fields
  struct
  {
    void *next;
  } service;

  //Standards fields
  ExtAddr_t parentAddress;
  ExtAddr_t childAddress;
 
  //Callback and Confirm
  APS_RemoveDeviceConf_t confirm;
  void (*APS_RemoveDeviceConf)(APS_RemoveDeviceConf_t *conf);
} PACK APS_RemoveDeviceReq_t;


/*****************************************************************************
  APSME-REMOVE-DEVICE.indication primitive
*****************************************************************************/
typedef struct
{
  //Standards fields
  ExtAddr_t srcAddress;
  ExtAddr_t childAddress;
} PACK APS_RemoveDeviceInd_t;
//============================================================================


#ifdef _HIGH_SECURITY_

typedef enum
{
  APS_NETWORK_KEY_TYPE =      0x01,
  APS_APP_KEY_TYPE =          0x02
} APS_RequestKeyType_t;

typedef enum
{
  APS_RKR_SUCCESS_STATUS                      = 0x00,
  APS_RKR_NO_SHORT_ADDRESS_STATUS             = 0x01,
  APS_RKR_SECURITY_FAIL_STATUS                = 0x02,
  APS_RKR_NOT_SENT_STATUS                     = 0x03
} APS_RkrStatus_t;
/*****************************************************************************
  (Out of ZigBee Standard) APSME-REQUEST-KEY.confirm primitive
*****************************************************************************/
typedef struct PACK
{
  APS_RkrStatus_t status;
} APS_RequestKeyConf_t;

/*****************************************************************************
  APSME-REQUEST-KEY.request primitive
*****************************************************************************/
typedef struct
{
  //Service fields
  struct
  {
    void *next;
  } service;

  //Standards fields
  ExtAddr_t destAddress;
  APS_RequestKeyType_t keyType;  
  ExtAddr_t partnerAddress;
 
  //Callback and Confirm
  APS_RequestKeyConf_t confirm;
  void (*APS_RequestKeyConf)(APS_RequestKeyConf_t *conf);
} PACK APS_RequestKeyReq_t;

/*****************************************************************************
  APSME-REQUEST-KEY.indication primitive
*****************************************************************************/
typedef struct
{
  //Standards fields
  ExtAddr_t srcAddress;
  APS_RequestKeyType_t keyType;  
  ExtAddr_t partnerAddress;
} PACK APS_RequestKeyInd_t;

#endif //#ifdef _HIGH_SECURITY_

//============================================================================




typedef enum
{
  APS_SKR_SUCCESS_STATUS                      = 0x00,
  APS_SKR_NO_SHORT_ADDRESS_STATUS             = 0x01,
  APS_SKR_SECURITY_FAIL_STATUS                = 0x02,
  APS_SKR_NOT_SENT_STATUS                     = 0x03
} APS_SkrStatus_t;

/*****************************************************************************
  (Out of ZigBee Standard) APSME-SWITCH-KEY.confirm primitive
*****************************************************************************/
typedef struct PACK
{
  APS_SkrStatus_t status;
} APS_SwitchKeyConf_t;


/*****************************************************************************
  APSME-SWITCH-KEY.request primitive
*****************************************************************************/
typedef struct
{
  //Service fields
  struct
  {
    void *next;
  } service;

  //Standards fields
  ExtAddr_t destAddress;
  uint8_t keySeqNumber;  

  //Callback and Confirm
  APS_SwitchKeyConf_t confirm;
  void (*APS_SwitchKeyConf)(APS_SwitchKeyConf_t *conf);
} PACK APS_SwitchKeyReq_t;


/*****************************************************************************
  APSME-SWITCH-KEY.indication primitive
*****************************************************************************/
typedef struct
{
  //Standards fields
  ExtAddr_t srcAddress;
  uint8_t keySeqNumber;  
} PACK APS_SwitchKeyInd_t;
//============================================================================

#ifdef _HIGH_SECURITY_

typedef enum
{
  APS_INITIATE_ACTION =               0x00,
  APS_RESPOND_ACCEPT_ACTION =         0x01,
  APS_RESPOND_REJECT_ACTION =         0x02
} APS_AuthenticateAction_t;

typedef enum
{
  APS_AUTH_SUCCESS_STATUS =               0x00,
  APS_AUTH_INVALID_PARAMETER_STATUS =     0x01,
  APS_AUTH_NO_KEY_STATUS =                0x02,
  APS_AUTH_NO_DATA_STATUS =               0x03,
  APS_AUTH_INVALID_CHALLENGE_STATUS =     0x04,
  APS_AUTH_INVALID_MAC_STATUS =           0x05,
  APS_AUTH_INVALID_KEY_STATUS =           0x06,
  APS_AUTH_TIMEOUT_STATUS =               0x07
} APS_AuthenticateStatus_t;

/*****************************************************************************
  APSME-AUTHENTICATE.confirm primitive
*****************************************************************************/
typedef struct
{
  //Standards fields
  ExtAddr_t address;
  APS_AuthenticateStatus_t status;
} PACK APS_AuthenticateConf_t;


/*****************************************************************************
  APSME-AUTHENTICATE.request primitive
*****************************************************************************/
typedef struct
{
  //Service fields
  struct
  {
    void *next;
  } service;

  //Standards fields
  ExtAddr_t partnerAddress;
  APS_AuthenticateAction_t action;
  uint8_t randomChallenge[16];

  //Callback and Confirm
  void (*APS_AuthenticateConf)(APS_AuthenticateConf_t *conf);
  APS_AuthenticateConf_t confirm;
} PACK APS_AuthenticateReq_t;

/*****************************************************************************
  APSME-AUTHENTICATE.indication primitive
*****************************************************************************/
typedef struct
{
  //Standards fields
  ExtAddr_t initiatorAddress;
  uint8_t randomChallenge[16];
} PACK APS_AuthenticateInd_t;

#endif //#ifdef _HIGH_SECURITY_

//\endcond
//============================================================================
#endif //#ifdef _SECURITY_



/*****************************************************************************
  APS Special Primitives
*****************************************************************************/
//\cond internal


/*****************************************************************************
  APSME-RESET.confirm primitive
*****************************************************************************/
typedef struct
{
  //Standard fields
  APS_Status_t status;
} PACK APS_ResetConf_t;

/*****************************************************************************
  APSME-RESET.request primitive
*****************************************************************************/
typedef struct
{
  //Standard fields
  bool commissioning;
  //Callback and Confirm
  void (*APS_ResetConf)(APS_ResetConf_t *conf);
  APS_ResetConf_t confirm;
} PACK APS_ResetReq_t; 

/*****************************************************************************
  APSME-START.confirm primitive
*****************************************************************************/
typedef struct
{
  //Standard fields
  APS_Status_t status;
} PACK APS_StartConf_t;

/*****************************************************************************
  APSME-START.request primitive
*****************************************************************************/
typedef struct
{
  //Standard fields
  
  //Callback and Confirm
  void (*APS_StartConf)(APS_StartConf_t *conf);
  APS_StartConf_t confirm;
} PACK APS_StartReq_t; 


/*****************************************************************************
  APSME-STOP.confirm primitive
*****************************************************************************/
typedef struct
{
  //Standard fields
  APS_Status_t status;
} PACK APS_StopConf_t;


/*****************************************************************************
  APSME-STOP.request primitive
*****************************************************************************/
typedef struct
{
  //Standard fields
    
  //Callback and Confirm
  void (*APS_StopConf)(APS_StopConf_t *conf);
  APS_StopConf_t confirm;
} PACK APS_StopReq_t; 
//\endcond
//============================================================================




/*****************************************************************************
  APS Endpoint Register/Unregister Primitives
*****************************************************************************/

/*************************************************************************/
typedef struct
{
  //Service fields
  struct
  {
    void *next;
    struct
    {
      uint8_t noIndication  :1; //If 
      uint8_t reserved      :7;
    };
  } service;
  
  //Standard fields
  SimpleDescriptor_t *simpleDescriptor;
  void (*APS_DataInd)(APS_DataInd_t *ind);
} PACK APS_RegisterEndpointReq_t;

/*************************************************************************/
typedef struct
{
  //Standard fields
  Endpoint_t endpoint;
} PACK APS_UnregisterEndpointReq_t;
//============================================================================



/******************************************************************************
                   Constants section
******************************************************************************/

/******************************************************************************
                   External variables section
******************************************************************************/

/******************************************************************************
                   Prototypes section
******************************************************************************/


/*****************************************************************************
  APS API Prototypes
*****************************************************************************/

/*****************************************************************************
  APS Task Manager API
*****************************************************************************/
// \cond internal
/*****************************************************************************
  Peforms APS sublayer processing.
  Parameters: None
  Returns:    None
*****************************************************************************/
extern void APS_TaskHandler(void);
// \endcond
//============================================================================

#ifdef _BINDING_
/*****************************************************************************
  APS Binding API
*****************************************************************************/
void APS_BindReq(APS_BindReq_t *req);
void APS_UnbindReq(APS_UnbindReq_t *req);
#endif //#ifdef _BINDING_

/*****************************************************************************
  APS AIB Manager API
*****************************************************************************/

/**************************************************************************/
extern void APS_GetReq(APS_GetReq_t *req);

/**************************************************************************/
extern void APS_SetReq(APS_SetReq_t *req);
//============================================================================

/*****************************************************************************
  APS Control Manager API
*****************************************************************************/

/*************************************************************************/
extern void APS_RegisterEndpointReq(APS_RegisterEndpointReq_t *req);

/*************************************************************************/
extern void APS_UnregisterEndpointReq(APS_UnregisterEndpointReq_t *req);

/*************************************************************************/
extern APS_RegisterEndpointReq_t *APS_GetEndpointList(void);

/*************************************************************************/
extern void APS_StopEndpointIndication(Endpoint_t endpoint);

/*************************************************************************/
extern void APS_ResumeEndpointIndication(Endpoint_t endpoint);

//\cond internal
/**************************************************************************/
extern void APS_ResetReq(APS_ResetReq_t *req);

/**************************************************************************/
extern void APS_Init(void);


/**************************************************************************/
extern void APS_StartReq(APS_StartReq_t *req);

/**************************************************************************/
extern void APS_StopReq(APS_StopReq_t *req);
//endcond
//============================================================================

/*****************************************************************************
  APS Data Manager API
*****************************************************************************/

/**************************************************************************/
extern void APS_DataReq(APS_DataReq_t *req);


#ifdef _APS_MULTICAST_
/*****************************************************************************
  APS Group Manager API
*****************************************************************************/

/**************************************************************************/
extern void APS_AddGroupReq(APS_AddGroupReq_t *req);

/**************************************************************************/
extern void APS_RemoveGroupReq(APS_RemoveGroupReq_t *req);

/**************************************************************************/
extern void APS_RemoveAllGroupsReq(APS_RemoveAllGroupsReq_t *req);

//\cond internal
/***************************************************************************/
APS_GroupTableEntry_t* APS_FindGroup(GroupAddr_t groupAddr, uint8_t *index);
//\endcond
//============================================================================
#endif


//\cond internal
#ifdef _SECURITY_
/*****************************************************************************
  APS Security Manager API
*****************************************************************************/
extern void APS_DeleteLinkKeyAndResetCounters(ExtAddr_t *extAddr);

/*****************************************************************************
  APS Master Key Set function
  Parameters: extAddr - extAddr pointer
              ket     - key material pointer
  Returns:    true - success
              false - no place
*****************************************************************************/
extern bool APS_SetMasterKey(ExtAddr_t *extAddr, uint8_t *key);

/*****************************************************************************
  APS Link Key Set function
  Parameters: extAddr - extAddr pointer
              ket     - key material pointer
  Returns:    true - success
              false - no place
*****************************************************************************/
extern bool APS_SetLinkKey(ExtAddr_t *extAddr, uint8_t *key);

#ifdef _HIGH_SECURITY_
//Key Establishment feature
extern void APS_EstablishKeyReq(APS_EstablishKeyReq_t *req);
extern void APS_EstablishKeyResp(APS_EstablishKeyResp_t *resp);
/*Must be provided*/
extern void APS_EstablishKeyInd(APS_EstablishKeyInd_t *ind);
//extern void APS_EstablishKeyConf(APS_EstablishKeyConf_t *conf);
#endif //#ifdef _HIGH_SECURITY_


//Transport Key feature
extern void APS_TransportKeyReq(APS_TransportKeyReq_t *req);
/*Must be provided*/
extern void APS_TransportKeyInd(APS_TransportKeyInd_t *ind);

//Update Device feature
extern void APS_UpdateDeviceReq(APS_UpdateDeviceReq_t *req);
/*Must be provided*/
extern void APS_UpdateDeviceInd(APS_UpdateDeviceInd_t *ind);


//Remove Device feature
extern void APS_RemoveDeviceReq(APS_RemoveDeviceReq_t *req);
/*Must be provided*/
extern void APS_RemoveDeviceInd(APS_RemoveDeviceInd_t *ind);

#ifdef _HIGH_SECURITY_
//Request Key feature
extern void APS_RequestKeyReq(APS_RequestKeyReq_t *req);
/*Must be provided*/
extern void APS_RequestKeyInd(APS_RequestKeyInd_t *ind);
#endif //#ifdef _HIGH_SECURITY_

//Switch Key feature
extern void APS_SwitchKeyReq(APS_SwitchKeyReq_t *req);
/*Must be provided*/
extern void APS_SwitchKeyInd(APS_SwitchKeyInd_t *ind);

#ifdef _HIGH_SECURITY_
//Autenticate feature
extern void APS_AuthenticateReq(APS_AuthenticateReq_t *req);
/*Must be provided*/
extern void APS_AuthenticateInd(APS_AuthenticateInd_t *ind);


//ApsKeyPairSet API
extern ApsKeyPairDescriptor_t *APS_GetKeyPairDescriptor(ExtAddr_t *address);
extern uint8_t *APS_GetMasterKey(ApsKeyPairDescriptor_t *keyPairDescriptor);
extern uint8_t *APS_GetLinkKey(ApsKeyPairDescriptor_t *keyPairDescriptor);
extern bool APS_DeleteKeyPair(ExtAddr_t *extAddr);
#endif //#ifdef _HIGH_SECURITY_

#endif





// \cond internal
/*****************************************************************************
  NLDE-DATA.indication handler 
  Parameters: req - primitive pointer
  Returns:    None
*****************************************************************************/
extern void NWK_DataInd(NWK_DataInd_t *req);


/*****************************************************************************
  NLDE-DATA.confirm handler
  Parameters: req - primitive pointer
  Returns:    None
*****************************************************************************/
extern void NWK_DataConf(NWK_DataConf_t *req);

/*****************************************************************************
  ZDO APSDE-DATA.indication handler
  Parameters: ind - primitive pointer
  Returns:    None
*****************************************************************************/
extern void APS_ZdoDataInd(APS_DataInd_t *ind);
// \endcond


#endif  //#ifndef _APS_H


//eof aps.h

---