zwapi_protocol_transport.h

Go to the documentation of this file.

/******************************************************************************
 * # License
 * <b>Copyright 2021 Silicon Laboratories Inc. www.silabs.com</b>
 ******************************************************************************
 * The licensor of this software is Silicon Laboratories Inc. Your use of this
 * software is governed by the terms of Silicon Labs Master Software License
 * Agreement (MSLA) available at
 * www.silabs.com/about-us/legal/master-software-license-agreement. This
 * software is distributed to you in Source Code format and is governed by the
 * sections of the MSLA applicable to Source Code.
 *
 *****************************************************************************/
 
#ifndef ZWAPI_PROTOCOL_TRANSPORT_H
#define ZWAPI_PROTOCOL_TRANSPORT_H
 
#include <stdint.h>
#include <stdbool.h>
#include "sl_status.h"
#include "zwave_node_id_definitions.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define NODEPARM_MAX 35
 
#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 TRANSMIT_OPTION_MULTICAST 0x40
 
#define TRANSMIT_EXPLORE_OPTION_ACK       TRANSMIT_OPTION_ACK
#define TRANSMIT_EXPLORE_OPTION_LOW_POWER TRANSMIT_OPTION_LOW_POWER
 
#define TRANSMIT_OPTION_2_TRANSPORT_SERVICE 0x01
#define TRANSMIT_OPTION_2_FOLLOWUP          0x08
 
#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 RECEIVE_STATUS_FOREIGN_HOMEID 0x80
 
#define TRANSMIT_COMPLETE_OK 0x00  
#define TRANSMIT_COMPLETE_NO_ACK \
  0x01  
#define TRANSMIT_COMPLETE_FAIL    0x02  
#define TRANSMIT_ROUTING_NOT_IDLE 0x03  
#define TRANSMIT_COMPLETE_NOROUTE  0x04
#define TRANSMIT_COMPLETE_VERIFIED 0x05  
 
#define ZW_ROUTE_LOST_FAILED 0x04  
#define ZW_ROUTE_LOST_ACCEPT 0x05  
 
#ifdef ZW_ROUTING_DEMO
#define TRANSMIT_ROUTED_ATTEMPT 0x08
#endif /*ZW_ROUTING_DEMO*/
 
#define ZW_MAX_CACHED_RETURN_ROUTE_DESTINATIONS 5
 
#define ZW_RF_TEST_SIGNAL_CARRIER           0x00
#define ZW_RF_TEST_SIGNAL_CARRIER_MODULATED 0x01
 
#define MAX_REPEATERS 4
 
#define LAST_USED_ROUTE_CONF_SIZE 1
#define LAST_USED_ROUTE_SIZE      (MAX_REPEATERS + LAST_USED_ROUTE_CONF_SIZE)
 
#define LAST_USED_ROUTE_REPEATER_0_INDEX 0
#define LAST_USED_ROUTE_REPEATER_1_INDEX 1
#define LAST_USED_ROUTE_REPEATER_2_INDEX 2
#define LAST_USED_ROUTE_REPEATER_3_INDEX 3
 
#define RSSI_NOT_AVAILABLE 127
#define RSSI_MAX_POWER_SATURATED 126
#define RSSI_BELOW_SENSITIVITY 125
#define RSSI_RESERVED_START 11
 
struct rssi_val {
  int8_t incoming[MAX_REPEATERS + 1];
};
 
typedef struct _S_ROUTE_LINK_ {
  uint8_t from;
  uint8_t to;
} S_ROUTE_LINK;
 
#define PROTOCOL_METADATA_LENGTH                        \
  (sizeof(uint8_t) + sizeof(uint8_t) + sizeof(uint32_t) \
   + sizeof(uint8_t))  
 
typedef struct _protocol_metadata_ {
  uint8_t data[PROTOCOL_METADATA_LENGTH];
  uint8_t data_length;
  uint8_t session_id;
  void *tx_session_id;
} protocol_metadata_t;
 
typedef enum _E_ROUTING_SCHEME_ {
  ROUTINGSCHEME_IDLE            = 0,
  ROUTINGSCHEME_DIRECT          = 1,  
  ROUTINGSCHEME_CACHED_ROUTE_SR = 2,  
  ROUTINGSCHEME_CACHED_ROUTE    = 3,  
  ROUTINGSCHEME_CACHED_ROUTE_NLWR
  = 4,                               
  ROUTINGSCHEME_ROUTE          = 5,  
  ROUTINGSCHEME_RESORT_DIRECT  = 6,  
  ROUTINGSCHEME_RESORT_EXPLORE = 7   
} e_routing_scheme_t;
 
typedef enum last_route_speed {
  UNKNOWN_SPEED                = 0,
  ZWAVE_9_6_KBITS_S            = 1,  
  ZWAVE_40_KBITS_S             = 2,  
  ZWAVE_100_KBITS_S            = 3,  
  ZWAVE_LONG_RANGE_100_KBITS_S = 4,  
} last_route_speed_t;
 
typedef struct zwapi_tx_report {
  uint16_t transmit_ticks;
  uint8_t number_of_repeaters;
  // This field is used to indicate ythe RSSI value of the acknowledgement frame
  int8_t ack_rssi;
  struct rssi_val rssi_values;
  // This field is used to indicate the channel number where the ACK received from.
  uint8_t ack_channel_number;
  // This field is used to indicate the channel number that is used to transmit the data.
  uint8_t tx_channel_number;
  e_routing_scheme_t route_scheme_state;
  uint8_t last_route_repeaters[LAST_USED_ROUTE_SIZE];
  // This field indicates if a 250ms beam was used to wake up the destination.
  bool beam_250ms;
  // This field indicates if a 1000ms beam was used to wake up the destination.
  bool beam_1000ms;
  last_route_speed_t last_route_speed;
  uint8_t routing_attempts;
  S_ROUTE_LINK last_failed_link;
  // This field is used to indicate the transmit power used for the transmission
  // The value 127 MUST indicate that the value is not available
  int8_t tx_power;
  // This field is used to indicate the measured noise floor during the outgoing transmission.
  int8_t measured_noise_floor;
  // This field is used to advertise the Tx Power used by the destination in its Ack MPDU frame.
  int8_t destination_ack_mpdu_tx_power;
  // This field is used to advertise the Tx Power used by the destination in its Ack MPDU frame.
  int8_t destination_ack_mpdu_measured_rssi;
  // This field is used to indicate the measured RSSI of the acknowledgement frame received from the destination.
  int8_t destination_ack_mpdu_measured_noise_floor;
} zwapi_tx_report_t;
 
sl_status_t zwapi_lock_route(bool lock);
 
sl_status_t zwapi_send_data_bridge(
  zwave_node_id_t source_node_id,
  zwave_node_id_t destination_node_id,
  const uint8_t *data,
  uint8_t data_length,
  uint8_t tx_options,
  void (*callback_function)(uint8_t, zwapi_tx_report_t *));
 
sl_status_t zwapi_send_data(zwave_node_id_t destination_node_id,
                            const uint8_t *data,
                            uint8_t data_length,
                            uint8_t tx_options,
                            void (*callback_function)(uint8_t,
                                                      zwapi_tx_report_t *));
 
sl_status_t zwapi_send_protocol_data(
  zwave_node_id_t destination_node_id,
  const uint8_t *data,
  uint8_t data_length,
  void *metadata,
  void (*callback_function)(uint8_t, zwapi_tx_report_t *));
 
sl_status_t zwapi_abort_send_data(void);
 
sl_status_t zwapi_send_data_multi(zwave_nodemask_t destination_node_mask,
                                  const uint8_t *data,
                                  uint8_t data_length,
                                  uint8_t tx_options,
                                  void (*callback_function)(uint8_t tx_status));
 
sl_status_t
  zwapi_send_data_multi_bridge(zwave_node_id_t source_node_id,
                               zwave_nodemask_t destination_node_mask,
                               const uint8_t *data,
                               uint8_t data_length,
                               uint8_t tx_options,
                               void (*callback_function)(uint8_t tx_status));
 
sl_status_t zwapi_send_nop(zwave_node_id_t destination,
                           uint8_t tx_options,
                           void (*callback_function)(uint8_t,
                                                     zwapi_tx_report_t *));
 
 
#ifdef __cplusplus
}
#endif
 
#endif  // ZWAPI_PROTOCOL_TRANSPORT_H