zcl_ota_server.h

Go to the documentation of this file.

/*
 * Copyright (c) 2019 Digi International Inc.,
 * All rights not expressly granted are reserved.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this file,
 * You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * Digi International Inc., 9350 Excelsior Blvd., Suite 700, Hopkins, MN 55343
 * ===========================================================================
 */

#ifndef ZCL_OTA_SERVER_H
#define ZCL_OTA_SERVER_H

#include "zigbee/zcl_ota_upgrade.h"
#include "zigbee/zcl.h"

XBEE_BEGIN_DECLS

int zcl_ota_upgrade_cluster_handler(const wpan_envelope_t FAR *envelope,
                                    void FAR *context);

#define ZCL_OTA_UPGRADE_CLUSTER_ENTRY \
    { ZCL_CLUST_OTA_UPGRADE, zcl_ota_upgrade_cluster_handler, \
      NULL, WPAN_CLUST_FLAG_SERVER }

// forward declaration to define zcl_ota_upgrade_read_fn
struct zcl_ota_upgrade_source_t;

typedef int (*zcl_ota_upgrade_read_fn)
    (const struct zcl_ota_upgrade_source_t *source,
     void *buffer, uint32_t offset, size_t bytes, const addr64 *client_ieee_be);

typedef struct zcl_ota_upgrade_source_t {
    zcl_ota_image_id_t          id;             
    uint32_t                    image_size;     

    zcl_ota_upgrade_read_fn     read_handler;   
    void                        *context;       
} zcl_ota_upgrade_source_t;

int zcl_ota_upgrade_image_notify(wpan_dev_t *wpan_dev,
                                 const zcl_ota_image_id_t *image_id,
                                 const wpan_endpoint_table_entry_t *src_ep,
                                 uint8_t dest_ep,
                                 const addr64 *ieee_addr_be,
                                 uint16_t network_addr);

const zcl_ota_upgrade_source_t
    *zcl_ota_get_upgrade_source(const addr64 *client_ieee_be,
                                const zcl_ota_image_id_t *id,
                                uint8_t zcl_command);

// TODO: If we support using a current_time field, pass that to the callback.
uint32_t zcl_ota_get_upgrade_time(const addr64 *client_ieee_be,
                                  const zcl_ota_upgrade_source_t *source);

XBEE_END_DECLS

#endif // ZCL_OTA_SERVER_H