pxbee_ota_client.h

Go to the documentation of this file.

/*
 * Copyright (c) 2010-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 PXBEE_OTA_CLIENT_H
#define PXBEE_OTA_CLIENT_H

#include "xbee/platform.h"
#include "xbee/xmodem.h"
#include "wpan/aps.h"
#include "xbee/cbuf.h"
#include "xbee/transparent_serial.h"

XBEE_BEGIN_DECLS

#define PXBEE_OTA_MAX_AUTH_LENGTH      64

typedef struct pxbee_ota_t {
   wpan_dev_t           *dev;    
   addr64               target;  
   uint16_t             flags;   
      #define PXBEE_OTA_FLAG_APS_ENCRYPT     0x0001

   union {
      xbee_cbuf_t          cbuf; 
      uint8_t              raw[255 + XBEE_CBUF_OVERHEAD];
   } rxbuf;
   xbee_xmodem_state_t  xbxm;    

   uint8_t              auth_data[PXBEE_OTA_MAX_AUTH_LENGTH];
   uint8_t              auth_length;      
} pxbee_ota_t;

int pxbee_ota_init( pxbee_ota_t *ota, wpan_dev_t *dev, const addr64 *target);

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

#define PXBEE_OTA_DATA_CLIENT_CLUST_ENTRY(ota, flags) \
   { DIGI_CLUST_SERIAL, _pxbee_ota_transparent_rx, ota,     \
      WPAN_CLUST_FLAG_INOUT | WPAN_CLUST_FLAG_NOT_ZCL | flags }

// client cluster used to kick off OTA updates
// flag should be WPAN_CLUST_FLAG_NONE or WPAN_CLUST_FLAG_ENCRYPT
#define PXBEE_OTA_CMD_CLIENT_CLUST_ENTRY(handler, context, flag)     \
   {  DIGI_CLUST_PROG_XBEE_OTA_UPD, handler,                         \
      context, (flag) | WPAN_CLUST_FLAG_CLIENT | WPAN_CLUST_FLAG_NOT_ZCL }

XBEE_BEGIN_DECLS

// If compiling in Dynamic C, automatically #use the appropriate C file.
#ifdef __DC__
   #use "pxbee_ota_client.c"
#endif

#endif      // PXBEE_OTA_CLIENT_H defined