association_plus_base.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2022 Silicon Laboratories Inc. <https://www.silabs.com/>
 *
 * SPDX-License-Identifier: BSD-3-Clause
 *
 */

 
#ifndef _ASSOCIATION_PLUS_BASE_H_
#define _ASSOCIATION_PLUS_BASE_H_
 
/****************************************************************************/
/*                              INCLUDE FILES                               */
/****************************************************************************/
 
#include "ZAF_types.h"
#include "ZW_TransportEndpoint.h"
#include <cc_association_config.h>
 
/****************************************************************************/
/*                     EXPORTED TYPES and DEFINITIONS                       */
/****************************************************************************/

 
#define FREE_VALUE                  0x00FF  // Valid for both Classic and LR variants!
 
/*
 * GroupID related definitions.
 */
#define NOT_VALID_GROUP_ID          0  
#define LIFELINE_GROUP_ID           1  
#define LIFELINE_ENDPOINT_ALLOWED   0  

typedef enum {
  NODE_LIST_STATUS_SUCCESS = 0,
  NODE_LIST_STATUS_NO_MORE_NODES,
  NODE_LIST_STATUS_ASSOCIATION_LIST_EMPTY,
  NODE_LIST_STATUS_ERROR_LIST,              
  NODE_LIST_STATUS_ERR_NO_TABLE_ENDPOINT,
  NODE_LIST_STATUS_ERR_UNKNOWN_PROFILE,
  NODE_LIST_STATUS_ERR_ENDPOINT_OUT_OF_RANGE,
  NODE_LIST_STATUS_ERR_GROUP_NBR_NOT_LEGAL,
  NODE_LIST_STATUS_ERR_LIFELINE_PROFILE_NOT_SUPPORTED,
  NODE_LIST_STATUS_ERR_LIFELINE_SUPPORT_NOT_CC_BASIC,
  NODE_LIST_STATUS_ERR_PROFILE_LIFELINE_ONLY_SUPPORT_IN_GRP_1,
} NODE_LIST_STATUS;
 
/****************************************************************************/
/*                              EXPORTED DATA                               */
/****************************************************************************/
 
// Nothing here.
 
/****************************************************************************/
/*                           EXPORTED FUNCTIONS                             */
/****************************************************************************/

void
CC_Association_Init(void);

void
CC_Association_Reset(void);

NODE_LIST_STATUS handleAssociationGetnodeList(
  uint8_t groupId,
  uint8_t ep,
  destination_info_t ** ppListOfNodes,
  uint8_t * pListLen);

e_cmd_handler_return_code_t
AssociationRemove(
  uint8_t groupId,
  uint8_t ep,
  ZW_MULTI_CHANNEL_ASSOCIATION_REMOVE_1BYTE_V2_FRAME* pCmd,
  uint8_t cmdLength);

void
AssociationGet(
  uint8_t endpoint,
  uint8_t * incomingFrame,
  uint8_t * outgoingFrame,
  uint8_t * outgoingFrameLength);

bool AssociationAddNode(
  uint8_t groupID,
  uint8_t endpoint,
  MULTICHAN_DEST_NODE_ID* pNode,
  bool multiChannelAssociation);
 
/***********************************************************************************
 * Functions used while doing transmission to association groups.
 **********************************************************************************/

void AssociationGetDestinationInit(destination_info_t * pFirstDestination);

bool AssociationGetBitAdressingDestination(destination_info_t ** ppNodeList,
                                           uint8_t * pListLength,
                                           destination_info_t * pNode);

uint32_t AssociationGetSinglecastNodeCount(void);

destination_info_t * AssociationGetNextSinglecastDestination(void);

uint8_t AssociationGetSinglecastEndpointDestinationCount(void);

uint8_t ApplicationGetLastActiveGroupId(void);

TRANSMIT_OPTIONS_TYPE_EX * ReqNodeList(
  AGI_PROFILE const * const pProfile,
  cc_group_t const * const pCurrentCmdGrp,
  const uint8_t sourceEndpoint);

 
#endif /* _ASSOCIATION_PLUS_BASE_H_ */