ebl_file.h

Go to the documentation of this file.

/*
 * Copyright (c) 2012 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. 11001 Bren Road East, Minnetonka, MN 55343
 * =======================================================================
 */
#ifndef __XBEE_EBL_FILE_H
#define __XBEE_EBL_FILE_H

#include "xbee/platform.h"

#define IMAGE_INFO_MAXLEN 32

#define EBLTAG_HEADER            0x0000

#define IMAGE_SIGNATURE_EM250    0xE250
#define IMAGE_SIGNATURE_EM260    0xE260
#define IMAGE_SIGNATURE_EM350    0xE350

typedef struct em3xx_header_t {
   uint16_t ebltag_be;        
   uint16_t length_be;        
   uint16_t version_be;       
   uint16_t signature_be;     
   uint8_t  reserved0[32];
   uint8_t  plat_info;        
   uint8_t  micro_info;       
   uint8_t  phy_info;         
   uint8_t  reserved1;
   uint8_t  znet_build;       
   uint8_t  znet_release;     
   uint8_t  reserved2[2];
   uint32_t timestamp_le;     
   uint8_t  image_info[32];   
   uint8_t  reserved3[60];
} em3xx_header_t;

typedef struct em2xx_header_t {
   uint16_t ebltag_be;        
   uint16_t length_be;        
   uint8_t  reserved0[2];
   uint16_t signature_be;
   uint32_t timestamp_be;     
   uint8_t  reserved1[16];
   uint8_t  image_info[32];   
   uint8_t  reserved2[4];
} em2xx_header_t;

typedef union ebl_file_header_t {
   struct {
      uint16_t    ebltag_be;     
      uint16_t    length_be;     
      uint8_t     reserved[2];
      uint16_t    signature_be;  
   } common;                     
   em2xx_header_t em2xx;
   em3xx_header_t em3xx;
} ebl_file_header_t;

typedef struct micro_info_t {
   uint8_t     type;
   const char  *description;
} micro_info_t;
#define MICRO_INFO_END     { 0xFF, NULL }

typedef struct platform_info_t {
   uint8_t              type;
   const micro_info_t   *micro_info_table;
} platform_info_t;
#define PLATFORM_INFO_END  { 0xFF, NULL }

extern const platform_info_t platform_info[];

const char *ebl_target_desc( uint8_t plat_info, uint8_t micro_info);

const char *ebl_phy_desc( uint8_t phy_info);

int ebl_header_dump( const void *buffer, uint16_t flags);
#define EBL_HEADER_DUMP_TARGET_DESC    (1<<0)
#define EBL_HEADER_DUMP_PHY_DESC       (1<<1)
#define EBL_HEADER_DUMP_EMBER_VER      (1<<2)
#define EBL_HEADER_DUMP_TIMESTAMP      (1<<3)
#define EBL_HEADER_DUMP_IMAGE_INFO     (1<<4)
#define EBL_HEADER_DUMP_EVERYTHING     0xFFFF

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

#endif      // __XBEE_EBL_FILE_H