tt_bundle_loader.h

Go to the documentation of this file.

/*
 * Copyright (c) 2026 Tenstorrent AI ULC
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef TT_BUNDLE_LOADER_H
#define TT_BUNDLE_LOADER_H
 
#include <errno.h>
#include <stdint.h>
#include <zephyr/toolchain.h>
 
#ifdef __cplusplus
extern "C" {
#endif

#define FW_BUNDLE_MANIFEST_UNUSED_WORD (0xA5A5A5A5U)

#define MANIFEST_ID_BL1 (0x314c4254U)

#define MANIFEST_ID_MIS (0x324c4254U)

#define FW_BUNDLE_TOC_ID (0x434f5450U)

#define TT_BUN2_STAGING_AREA_ADDR 0xc0066400UL

#define TT_BUN3_STAGING_AREA_ADDR 0xc0066400UL

#define FW_BUNDLE_ENCRYPTION_TYPE_AES (0x01)

#define FW_BUNDLE_SIGNATURE_TYPE_RSA (0x01)

#define FW_BUNDLE_SIGNATURE_TYPE_ECC_P256 (0x02)

#define FW_BUNDLE_FUSE_KEY_SEL_ROM (0x0)

#define FW_BUNDLE_FUSE_KEY_SEL_PUBK_HASH0 (0x1)

#define FW_BUNDLE_FUSE_KEY_SEL_PUBK_HASH1 (0x2)

#define FW_BUNDLE_FUSE_KEY_SEL_SOP_PUBK (0x4)

#define FW_BUNDLE_FUSE_KEY_SEL_SYS_PUBK (0x5)

#define FW_BUNDLE_IMG_TYPE_SEP_BL1 (0x0000314c42504553ULL)

#define FW_BUNDLE_IMG_TYPE_SEP_MIS (0x0000324c42504553ULL)

#define FW_BUNDLE_IMG_TYPE_SMC_BL0P5 (0x3550304c42434d53ULL)

#define FW_BUNDLE_IMG_TYPE_SMC_BL1 (0x0000314c42434d53ULL)

#define FW_BUNDLE_IMG_TYPE_SMC_MIS (0x0000324c42434d53ULL)

union fw_bundle_lc_state {
        uint32_t u32_all;
        struct {
                uint32_t test_dev: 1;

                uint32_t prod: 1;

                uint32_t prod_end: 1;

                uint32_t rma_sip: 1;

                uint32_t rma_chiplet: 1;
        } f;
};

union fw_bundle_auth_flags {
        uint32_t u32_all;
 
        struct {
                uint32_t bl1_demotion: 1;

                uint32_t encrypted_payload: 1;

                uint32_t security_version_update: 1;

                uint32_t reserved: 29;
        } f;
};
 
union fw_bundle_public_key_sel {
        uint16_t u16_all;
 
        struct {
                uint16_t key_index: 4;

                uint16_t key_sel: 3;

                uint16_t reserved: 9;
        } f;
};
 
union fw_bundle_sem_ver {
        uint64_t u64_all;
 
        struct {
                uint64_t patch_version: 24;

                uint64_t minor_version: 24;

                uint64_t major_version: 16;
        } f;
};
 
union fw_bundle_unauthed_flags {
        uint32_t u32_all;
 
        struct {
                uint32_t mis_demotion: 1;

                uint32_t reserved: 23;

                uint32_t impl_reserved: 8;
        } f;
};
 
struct fw_bundle_manifest {
        uint32_t manifest_identifier;

        uint16_t manifest_version_major;

        uint16_t manifest_version_minor;

        uint32_t manifest_length;

        uint32_t reserved;

        uint64_t selector_bits;

        uint8_t chiplet_id[32];

        uint8_t package_id[32];

        union fw_bundle_lc_state lifecycle_states;

        union fw_bundle_auth_flags authenticated_flags;

        uint8_t encryption_iv[32];

        uint8_t encryption_kdf_input[32];

        uint16_t reserved_0;

        uint16_t security_version;

        uint8_t encryption_type;

        uint8_t signature_type;

        union fw_bundle_public_key_sel public_key_sel;

        uint8_t public_key[384];

        uint8_t payload_hash[32];

        uint64_t payload_hashed_length;

        int64_t timestamp;

        uint64_t payload_length;

        union fw_bundle_sem_ver manifest_content_version;

        uint8_t manifest_description[128];

        uint8_t signature[384];

        uint8_t manifest_hash[32];

        int64_t payload_offset;

        union fw_bundle_unauthed_flags flags;

        uint8_t reserved_1[12];
} __packed;
 
struct fw_bundle_toc_entry {
        uint64_t type;

        uint64_t offset;

        uint64_t length;

        union fw_bundle_sem_ver version;

        uint64_t load_addr;

        uint64_t entry_point;

        uint64_t reserved;

        uint8_t hash[32];

        uint8_t description[128];
} __packed;

struct fw_bundle_toc {
        uint32_t toc_identifier;

        uint16_t toc_version_major;

        uint16_t toc_version_minor;

        uint64_t payload_length;

        uint64_t image_count;

        uint64_t reserved;

        struct fw_bundle_toc_entry entries[];
} __packed;
 
#ifdef __cplusplus
}
#endif
 
#endif /*TT_BUNDLE_LOADER_H*/