zwave_command_class_firmware_update_internals.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_COMMAND_CLASS_FIRMWARE_UPDATE_INTERNALS_H
#define ZWAVE_COMMAND_CLASS_FIRMWARE_UPDATE_INTERNALS_H
 
#include "attribute_store.h"
 
typedef enum zwave_firmware_transfer_state {
  // No Firmware transfer is ongoing
  IDLE = 0,
  // A Firmware transfer is ongoing
  ONGOING = 1,
  // A Firmware transfer is completed, wait for a subsequent activation
  WAITING_FOR_ACTIVATION = 2,
  // A Firmware transfer is completed, waiting for the node to reboot
  WAITING_FOR_REBOOT = 3
} zwave_firmware_transfer_state_t;
 
typedef enum zwave_firmware_transfer_status {
  SUCCESS            = 0,
  ABORTED            = 1,
  NOT_AUTHORIZED     = 2,
  INVALID_IMAGE      = 3,
  REQUIRE_MORE_IMAGE = 4,
  NOT_SUPPORTED      = 5,
} zwave_firmware_transfer_status_t;
 
#ifdef __cplusplus
extern "C" {
#endif
 
sl_status_t
  set_firmware_transfer_file(attribute_store_node_t firmware_transfer_node,
                             const char *file_name);
 
sl_status_t set_firmware_transfer_last_status(
  attribute_store_node_t firmware_transfer_node,
  zwave_firmware_transfer_status_t status);
 
sl_status_t set_transfer_offset(attribute_store_node_t firmware_transfer_node,
                                uint32_t transfer_offset);
 
uint16_t
  firmware_transfer_get_theoretical_max_fragment_size(attribute_store_node_t endpoint_node);
 
sl_status_t set_firmware_transfer_fragment_size(
  attribute_store_node_t firmware_transfer_node);
 
bool node_supports_firmware_activation(attribute_store_node_t endpoint_node);
 
bool node_supports_cc(attribute_store_node_t endpoint_node);
 
bool is_firmware_target_valid(attribute_store_node_t endpoint_node,
                              uint32_t firmware_target);
 
bool is_firmware_update_ongoing(attribute_store_node_t endpoint_node);
 
sl_status_t
  postpone_firmware_update_expiry(attribute_store_node_t endpoint_node);
 
#ifdef __cplusplus
}
#endif
 
#endif  //ZWAVE_COMMAND_CLASS_FIRMWARE_UPDATE_INTERNALS_H