ZAF_AssociationDataStore.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Silicon Laboratories Inc. <https://www.silabs.com/>
//
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef ZAF_APPLICATIONUTILITIES_ZAF_ASSOCIATIONDATASTORE_H_
#define ZAF_APPLICATIONUTILITIES_ZAF_ASSOCIATIONDATASTORE_H_
 
#include <stdbool.h>
#include <stdint.h>
#include <ZW_security_api.h>
 
typedef void * ZAF_ADS_Handle_t;
 
// These following defines must be aligned with the structs in the private implementation
// (made as individual defines in order to easier assert on each of them)
#define ZAF_ADS_HEADER_SIZE 4
#define ZAF_ADS_ELEMENT_SIZE 20
 
// Calculate size of storage
#define ZAF_ADS_STORAGE_SIZE(num_elements) (ZAF_ADS_HEADER_SIZE + (num_elements) * ZAF_ADS_ELEMENT_SIZE)
#define ZAF_ADS_STORAGE(name, num_elements) union { void *align; uint8_t storage[ZAF_ADS_STORAGE_SIZE(num_elements)]; } name
 
typedef enum
{
  SECURITY_HIGHEST_CLASS_NOT_DISCOVERED,              
  SECURITY_HIGHEST_CLASS_DISCOVERED_NOT_GRANTED_TO_ME,
  SECURITY_HIGHEST_CLASS_DISCOVERED                   
} e_ZAF_ADS_SecurityHighestClassState_t;
 
typedef struct
{
  security_key_t securityKey;
  e_ZAF_ADS_SecurityHighestClassState_t state;
} s_ZAF_ADS_SecurityHighestClass_t;
 
typedef enum
{
  CC_CAPABILITY_NOT_DISCOVERED,
  CC_CAPABILITY_SUPPORTED,     
  CC_CAPABILITY_NOT_SUPPORTED  
} e_ZAF_ADS_CC_Capability_t;
 
typedef enum
{
    ZAF_ADS_CC_SUPERVISION,  
    ZAF_ADS_CC_MULTI_COMMAND,
    ZAF_ADS_MAX_CC           
} e_ZAF_ADS_CommandClass_t;
 
ZAF_ADS_Handle_t ZAF_ADS_Init (void* pStorage, uint8_t MaxNodeCount);
 
bool ZAF_ADS_Delete(ZAF_ADS_Handle_t handle, uint8_t NodeID);
 
e_ZAF_ADS_SecurityHighestClassState_t ZAF_ADS_GetNodeHighestSecurityClass(
    ZAF_ADS_Handle_t handle,
    uint8_t NodeID,
    security_key_t * pHighestClass);
 
bool ZAF_ADS_SetNodeHighestSecurityClass(
    ZAF_ADS_Handle_t handle,
    uint8_t NodeID,
    security_key_t HighestClass);
 
e_ZAF_ADS_CC_Capability_t ZAF_ADS_IsNodeSupportingCC(
    ZAF_ADS_Handle_t handle,
    uint8_t NodeID,
    e_ZAF_ADS_CommandClass_t commandClass);
 
bool ZAF_ADS_SetNodeIsSupportingCC(
    ZAF_ADS_Handle_t handle,
    uint8_t NodeID,
    e_ZAF_ADS_CommandClass_t commandClass,
    e_ZAF_ADS_CC_Capability_t CC_Capability);
 
 
#endif /* ZAF_APPLICATIONUTILITIES_ZAF_ASSOCIATIONDATASTORE_H_ */