mbin.h

/*
 * Copyright 2023 Morse Micro
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#pragma once
 
#ifndef PACKED
#define PACKED __attribute__((packed))
#endif
 
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,
};
 
enum mbin_coredump_region_types
{
    COREDUMP_MEM_REGION_GENERAL = 0x0001,
    COREDUMP_MEM_REGION_ASSERT_INFO = 0x0002,
};
 
struct PACKED mbin_tlv_hdr
{
    uint16_t type;
    uint16_t len;
};
 
struct PACKED mbin_segment_hdr
{
    uint32_t base_address;
};
 
struct PACKED mbin_deflated_segment_hdr
{
    uint32_t base_address;
    uint16_t chunk_size;
    uint8_t zlib_header[2];
};
 
struct PACKED mbin_regdom_hdr
{
    uint8_t country_code[2];
    uint16_t reserved;
};
 
#define MBIN_SW_MAGIC_NUMBER (0x57534d4d)
#define MBIN_FW_MAGIC_NUMBER (0x57464d4d)
#define MBIN_BCF_MAGIC_NUMBER (0x43424d4d)