transport_service.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 TRANSPORT_SERVICE_H
#define TRANSPORT_SERVICE_H
 
#include "stdint.h"
#include "stdbool.h"
#include "zwave_node_id_definitions.h"
#ifdef __cplusplus
extern "C" {
#endif
 
typedef zwave_node_id_t ts_node_id_t;
#define COMMAND_CLASS_TRANSPORT_SERVICE_V2 0x55
typedef void (*on_transport_service_send_data_complete_t)(uint8_t status,
                                                          void *user);
 
typedef void (*on_lower_layer_send_data_complete_t)(uint8_t status, void *user);
 
typedef uint8_t (*send_data_t)(
  ts_node_id_t source,
  ts_node_id_t dest,
  const uint8_t *payload,
  uint16_t payload_len,
  uint8_t no_of_expected_responses,
  const on_lower_layer_send_data_complete_t on_lower_layer_send_data_complete);
 
typedef void (*upper_layer_command_handler_t)(ts_node_id_t source,
                                              ts_node_id_t dest,
                                              const uint8_t *frame,
                                              uint16_t frame_len);
 
void transport_service_init(
  ts_node_id_t my_node_id,
  const upper_layer_command_handler_t upper_layer_command_handler,
  const send_data_t send_data);
 
typedef enum { SINGLECAST, BROADCAST, MULTICAST } receive_type;
 
typedef enum {
  TRANSPORT_SERVICE_SEND_SUCCESS,
  TRANSPORT_SERVICE_SEND_FAILURE,
  TRANSPORT_SERVICE_BUSY,
  TRANSPORT_SERVICE_WILL_OVERFLOW
} transport_service_send_data_return_code_t;
 
transport_service_send_data_return_code_t transport_service_send_data(
  ts_node_id_t source,
  ts_node_id_t dest,
  const uint8_t *payload,
  uint16_t payload_len,
  uint16_t max_frame_len,
  const on_transport_service_send_data_complete_t on_send_complete);
 
bool transport_service_on_frame_received(ts_node_id_t source,
                                         ts_node_id_t dest,
                                         receive_type rx_type,
                                         const uint8_t *frame_data,
                                         uint8_t frame_length);
 
#ifdef __cplusplus
}
#endif
 
#endif