ZW_transport_api.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_TRANSPORT_API_H_
#define _ZW_TRANSPORT_API_H_
#include <ZW_security_api.h>
#include <zpal_radio.h>
 
#define ZW_MAX_NODES        232
 
#define ZW_MAX_NODES_LR    1024
 
#define LOWEST_LONG_RANGE_NODE_ID   (0x0100)
 
#define HIGHEST_LONG_RANGE_NODE_ID  (LOWEST_LONG_RANGE_NODE_ID + ZW_MAX_NODES_LR - 1)
 
#define NODEPARM_MAX       35   
#define HOMEID_LENGTH      4    
 
typedef uint32_t TxOptions_t;  
 
#define TRANSMIT_OPTION_ACK                     0x01  
#define TRANSMIT_OPTION_LOW_POWER               0x02  
#define TRANSMIT_OPTION_MULTICAST_AS_BROADCAST  0x02  
#define TRANSMIT_OPTION_AUTO_ROUTE              0x04  
#define TRANSMIT_OPTION_NO_ROUTE                0x10  
#define TRANSMIT_OPTION_EXPLORE                 0x20  
 
#define RECEIVE_STATUS_ROUTED_BUSY    0x01
#define RECEIVE_STATUS_LOW_POWER      0x02
#define RECEIVE_STATUS_TYPE_MASK      0x0C
#define RECEIVE_STATUS_TYPE_SINGLE    0x00
#define RECEIVE_STATUS_TYPE_BROAD     0x04
#define RECEIVE_STATUS_TYPE_MULTI     0x08
#define RECEIVE_STATUS_TYPE_EXPLORE   0x10
#define RECEIVE_STATUS_FOREIGN_FRAME  0x40
 
#define NODE_BROADCAST              0xFF    
#define ZW_TEST_NOT_A_NODEID        0x00
 
#define TRANSMIT_COMPLETE_OK      0x00  
#define TRANSMIT_COMPLETE_NO_ACK  0x01  
#define TRANSMIT_COMPLETE_FAIL    0x02  
#define TRANSMIT_ROUTING_NOT_IDLE 0x03  
#ifdef ZW_CONTROLLER
/* Assign route transmit complete but no routes was found */
#define TRANSMIT_COMPLETE_NOROUTE 0x04  
#endif
#define TRANSMIT_COMPLETE_VERIFIED 0x05 
 
#define ZW_MAX_CACHED_RETURN_ROUTE_DESTINATIONS  5
 
#define MAX_REPEATERS                            4
 
#define LAST_USED_ROUTE_CONF_SIZE                1
#define LAST_USED_ROUTE_SIZE                     (MAX_REPEATERS + LAST_USED_ROUTE_CONF_SIZE)
 
struct s_rssi_val {
  signed char incoming[MAX_REPEATERS + 1];
};
 
 
typedef struct _S_ROUTE_LINK_T_
{
  uint8_t from;
  uint8_t to;
} S_ROUTE_LINK_T;
 
 
typedef struct _TX_STATUS_TYPE_
{
  uint32_t TransmitTicks;  
  uint8_t bRepeaters;         
  struct s_rssi_val rssi_values;
  uint8_t bACKChannelNo;
  uint8_t bLastTxChannelNo;
  uint8_t bRouteSchemeState;
  uint8_t pLastUsedRoute[LAST_USED_ROUTE_SIZE];
  uint8_t bRouteTries;
  S_ROUTE_LINK_T bLastFailedLink;
  int8_t bUsedTxpower;
  int8_t bMeasuredNoiseFloor;
  int8_t bDestinationAckUsedTxPower;
  int8_t bDestinationAckMeasuredRSSI;
  int8_t bDestinationAckMeasuredNoiseFloor;
} TX_STATUS_TYPE;
 
 
typedef struct _RECEIVE_OPTIONS_TYPE
{
  uint8_t  rxStatus;
  union{
      uint8_t  array[HOMEID_LENGTH];
      uint32_t word;
  }homeId;
  node_id_t  sourceNode;
  node_id_t  destNode;
  signed char rxRSSIVal;
  enum SECURITY_KEY securityKey;
  uint8_t rxChannelNo;
  bool isLongRangeChannel;
  int8_t bSourceTxPower;
  int8_t bSourceNoiseFloor;
} RECEIVE_OPTIONS_TYPE;
 
#define S2_TXOPTION_VERIFY_DELIVERY 1
 
#define S2_TXOPTION_SINGLECAST_FOLLOWUP 2
 
#define S2_TXOPTION_FIRST_SINGLECAST_FOLLOWUP 4
 
 
typedef struct _TRANSMIT_OPTIONS_TYPE
{
  node_id_t destNode;
  node_id_t bSrcNode;
  TxOptions_t txOptions;
  uint8_t txSecOptions;
  enum SECURITY_KEY securityKey;
  uint8_t txOptions2;
} TRANSMIT_OPTIONS_TYPE;
 
 
typedef struct _TRANSMIT_MULTI_OPTIONS_TYPE
{
  uint8_t groupID;
  node_id_t bSrcNode;
  TxOptions_t txOptions;
  enum SECURITY_KEY securityKey;
} TRANSMIT_MULTI_OPTIONS_TYPE;
 
#endif /* _ZW_TRANSPORT_API_H_ */