TT-System-Firmware APIs 19.15.99
Tenstorrent Firmware
Loading...
Searching...
No Matches
fw_bundle_toc_entry Struct Reference

#include <tt_bundle_loader.h>

Collaboration diagram for fw_bundle_toc_entry:

Data Fields

uint64_t type
 Defines type of image, as well as the destination component.
uint64_t offset
 Offset from the start of the payload to the start of this image. Must be a multiple of 8.
uint64_t length
 Length in bytes of this image This image occupies the space in the payload starting at offset bytes from the start of the payload TOC and continuing for length bytes. There can be 'unused' bytes in the payload between then end of one image and the beginning of another.
union fw_bundle_sem_ver version
 version for the image described by this TOC entry.
uint64_t load_addr
 Load address for this image. Load address for this image. Interpreted on a per-image type basis. May not apply to all image types.
uint64_t entry_point
 Entry point for this image. Interpreted on a per-image type basis, may be in different address space than load_addr. May not apply to all images.
uint64_t reserved
 Reserved - must be 0.
uint8_t hash [32]
 SHA-256 hash over this image.
uint8_t description [128]
 ASCII NULL terminated string describing the manifest and payload. This is provided to make identifying binary manifests more precise and human readable. This is expected to contain version control details, release status and other useful information. This field is not used by firmware. The final byte of this field (ie manifest_description[127]) must be 0 and this will be set to 0 by software that uses this field to ensure NULL termination.

Field Documentation

◆ description

uint8_t fw_bundle_toc_entry::description[128]

ASCII NULL terminated string describing the manifest and payload. This is provided to make identifying binary manifests more precise and human readable. This is expected to contain version control details, release status and other useful information. This field is not used by firmware. The final byte of this field (ie manifest_description[127]) must be 0 and this will be set to 0 by software that uses this field to ensure NULL termination.

◆ entry_point

uint64_t fw_bundle_toc_entry::entry_point

Entry point for this image. Interpreted on a per-image type basis, may be in different address space than load_addr. May not apply to all images.

◆ hash

uint8_t fw_bundle_toc_entry::hash[32]

SHA-256 hash over this image.

◆ length

uint64_t fw_bundle_toc_entry::length

Length in bytes of this image This image occupies the space in the payload starting at offset bytes from the start of the payload TOC and continuing for length bytes. There can be 'unused' bytes in the payload between then end of one image and the beginning of another.

◆ load_addr

uint64_t fw_bundle_toc_entry::load_addr

Load address for this image. Load address for this image. Interpreted on a per-image type basis. May not apply to all image types.

◆ offset

uint64_t fw_bundle_toc_entry::offset

Offset from the start of the payload to the start of this image. Must be a multiple of 8.

◆ reserved

uint64_t fw_bundle_toc_entry::reserved

Reserved - must be 0.

◆ type

uint64_t fw_bundle_toc_entry::type

Defines type of image, as well as the destination component.

◆ version

union fw_bundle_sem_ver fw_bundle_toc_entry::version

version for the image described by this TOC entry.


The documentation for this struct was generated from the following file: