zwave_controller_callbacks.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 ZWAVE_CONTROLLER_CALLBACKS_H
#define ZWAVE_CONTROLLER_CALLBACKS_H
#include "zwave_rx_definitions.h"
#include "zwave_network_management_types.h"
#include "zwave_keyset_definitions.h"
#include "zwave_generic_types.h"
#include "zwapi_protocol_transport.h"
 
typedef struct {
  void (*on_state_updated)(zwave_network_management_state_t state);
 
  void (*on_error)(zwave_network_management_error_t error);
 
  void (*on_node_id_assigned)(zwave_node_id_t node_id,
                              bool included_by_us,
                              zwave_protocol_t inclusion_protocol);
 
  void (*on_node_deleted)(zwave_node_id_t node_id);
 
  void (*on_node_added)(sl_status_t status,
                        const zwave_node_info_t *nif,
                        zwave_node_id_t node_id,
                        const zwave_dsk_t dsk,
                        zwave_keyset_t granted_keys,
                        zwave_kex_fail_type_t kex_fail_type,
                        zwave_protocol_t inclusion_protocol);
 
  void (*on_network_address_update)(zwave_home_id_t home_id,
                                    zwave_node_id_t node_id);
 
  void (*on_new_network_entered)(zwave_home_id_t home_id,
                                 zwave_node_id_t node_id,
                                 zwave_keyset_t granted_keys,
                                 zwave_kex_fail_type_t kex_fail_type);
 
  void (*on_keys_report)(bool csa, zwave_keyset_t keys);
 
  void (*on_dsk_report)(uint8_t input_length,
                        zwave_dsk_t dsk,
                        zwave_keyset_t keys);
 
  void (*on_application_frame_received)(
    const zwave_controller_connection_info_t *connection_info,
    const zwave_rx_receive_options_t *rx_options,
    const uint8_t *frame_data,
    uint16_t frame_length);
 
  void (*on_protocol_frame_received)(
    const zwave_controller_connection_info_t *connection_info,
    const zwave_rx_receive_options_t *rx_options,
    const uint8_t *frame_data,
    uint16_t frame_length);
 
  void (*on_protocol_cc_encryption_request)(
    const zwave_node_id_t destination_node_id,
    const uint8_t payload_length,
    const uint8_t *const payload,
    const uint8_t protocol_metadata_length,
    const uint8_t *const protocol_metadata,
    const uint8_t use_supervision,
    const uint8_t session_id);
 
  void (*on_smart_start_inclusion_request)(uint32_t home_id,
                                           bool already_included,
                                           const zwave_node_info_t *node_info,
                                           zwave_protocol_t inclusion_protocol);
 
  void (*on_node_information)(zwave_node_id_t node_id,
                              const zwave_node_info_t *node_info);
 
  void (*on_new_suc)(zwave_node_id_t suc_node_id);
 
  void (*on_node_info_req_failed)(zwave_node_id_t node_id);
 
  void (*on_multicast_group_deleted)(zwave_multicast_group_id_t group_id);
 
  void (*on_request_neighbor_update)(uint8_t status);
 
  void (*on_frame_transmission)(bool transmission_successful,
                                const zwapi_tx_report_t *tx_report,
                                zwave_node_id_t node_id);
  void (*on_rx_frame_received)(zwave_node_id_t node_id);
} zwave_controller_callbacks_t;
 
typedef sl_status_t (*zwave_controller_reset_step_t)(void);
 
#define ZWAVE_CONTROLLER_MAXIMUM_CALLBACK_SUBSCRIBERS 20
#define ZWAVE_CONTROLLER_RESET_STEP_MIN_PRIORITY 0
 
#define ZWAVE_CONTROLLER_CLEAN_UP_ASSOCIATIONS_STEP_PRIORITY 1
#define ZWAVE_CONTROLLER_DEVICE_RESET_LOCALLY_STEP_PRIORITY 2
#define ZWAVE_CONTROLLER_SMART_START_LIST_UPDATE_STEP_PRIORITY 3
#define ZWAVE_CONTROLLER_TX_FLUSH_RESET_STEP_PRIORITY 4
#define ZWAVE_CONTROLLER_ZWAVE_NETWORK_MANAGEMENT_RESET_STEP_PRIORITY 5
 
#ifdef __cplusplus
extern "C" {
#endif
 
sl_status_t zwave_controller_register_callbacks(
  const zwave_controller_callbacks_t *callbacks);
 
sl_status_t zwave_controller_deregister_callbacks(
  const zwave_controller_callbacks_t *callbacks);
 
sl_status_t zwave_controller_register_reset_step(
  const zwave_controller_reset_step_t step_function, int32_t priority);
 
void zwave_controller_on_reset_step_complete(int32_t priority);
 
void zwave_controller_callbacks_init();
 
#ifdef __cplusplus
}
#endif
#endif  //ZWAVE_CONTROLLER_CALLBACKS_H