Morse Micro IoT SDK  2.11.2
Morse BINary Loader API

Detailed Description

This file defines the structure of the MBIN file.

Data Structures

struct  mbin_tlv_hdr
 TLV header data structure. More...
 
struct  mbin_segment_hdr
 Data header in a FIELD_TYPE_XX_SEGMENT field. More...
 
struct  mbin_deflated_segment_hdr
 Data header in a FIELD_TYPE_XX_SEGMENT_DEFLATED field. More...
 
struct  mbin_regdom_hdr
 Data header in a FIELD_TYPE_BCF_REGDOM field. More...
 

Macros

#define PACKED   __attribute__((packed))
 Macro for the compiler packed attribute. More...
 
#define MBIN_SW_MAGIC_NUMBER   (0x57534d4d)
 Expected value of the magic field for a SW image MMSW. More...
 
#define MBIN_FW_MAGIC_NUMBER   (0x57464d4d)
 Expected value of the magic field for a firmware image MMFW. More...
 
#define MBIN_BCF_MAGIC_NUMBER   (0x43424d4d)
 Expected value of the magic field for a BCF MMBC. More...
 

Enumerations

enum  mbin_tlv_types {
  FIELD_TYPE_FW_TLV_BCF_ADDR = 0x0001 , FIELD_TYPE_COREDUMP_MEM_REGION = 0x0002 , FIELD_TYPE_MAGIC = 0x8000 , FIELD_TYPE_FW_SEGMENT = 0x8001 ,
  FIELD_TYPE_FW_SEGMENT_DEFLATED = 0x8002 , FIELD_TYPE_BCF_BOARD_CONFIG = 0x8100 , FIELD_TYPE_BCF_REGDOM = 0x8101 , FIELD_TYPE_BCF_BOARD_DESC = 0x8102 ,
  FIELD_TYPE_BCF_BUILD_VER = 0x8103 , FIELD_TYPE_SW_SEGMENT = 0x8201 , FIELD_TYPE_SW_SEGMENT_DEFLATED = 0x8202 , FIELD_TYPE_EOF = 0x8f00 ,
  FIELD_TYPE_EOF_WITH_SIGNATURE = 0x8f01
}
 Enumeration of TLV field types. More...
 
enum  mbin_coredump_region_types { COREDUMP_MEM_REGION_GENERAL = 0x0001 , COREDUMP_MEM_REGION_ASSERT_INFO = 0x0002 }
 Enumeration of core dump memory region types. More...
 

Macro Definition Documentation

◆ MBIN_BCF_MAGIC_NUMBER

#define MBIN_BCF_MAGIC_NUMBER   (0x43424d4d)

Expected value of the magic field for a BCF MMBC.

Definition at line 88 of file mbin.h.

◆ MBIN_FW_MAGIC_NUMBER

#define MBIN_FW_MAGIC_NUMBER   (0x57464d4d)

Expected value of the magic field for a firmware image MMFW.

Definition at line 86 of file mbin.h.

◆ MBIN_SW_MAGIC_NUMBER

#define MBIN_SW_MAGIC_NUMBER   (0x57534d4d)

Expected value of the magic field for a SW image MMSW.

Definition at line 84 of file mbin.h.

◆ PACKED

#define PACKED   __attribute__((packed))

Macro for the compiler packed attribute.

Definition at line 19 of file mbin.h.

Enumeration Type Documentation

◆ mbin_coredump_region_types

Enumeration of core dump memory region types.

Definition at line 41 of file mbin.h.

◆ mbin_tlv_types

Enumeration of TLV field types.

Definition at line 23 of file mbin.h.