tt_boot_fs.h

Go to the documentation of this file.

/*
 * Copyright (c) 2024 Tenstorrent AI ULC
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef _TT_BOOT_FS_H_
#define _TT_BOOT_FS_H_
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include <zephyr/device.h>
#include <zephyr/drivers/flash.h>
#include <zephyr/devicetree.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define TT_BOOT_FS_FD_HEAD_ADDR            (0x0)
/* These defines must change when BOOT_START or DESC_REGION_SIZE change in python toolchain */
#define TT_BOOT_FS_SECURITY_BINARY_FD_ADDR (0x3FE0)
#define TT_BOOT_FS_FAILOVER_HEAD_ADDR      (0x4000)
#define TT_BOOT_FS_IMAGE_TAG_SIZE          8
 
struct device;
 
typedef struct {
        uint32_t image_size: 24;
        uint32_t invalid: 1;
        uint32_t executable: 1;
        uint32_t fd_flags_rsvd: 6;
} fd_flags;
 
typedef union {
        uint32_t val;
        fd_flags f;
} fd_flags_u;
 
typedef struct {
        uint32_t signature_size: 12;
        uint32_t sb_phase: 8; /* 0 - Phase0A, 1 - Phase0B */
} security_fd_flags;
 
typedef union {
        uint32_t val;
        security_fd_flags f;
} security_fd_flags_u;
 
/* File descriptor */
typedef struct {
        uint32_t spi_addr;
        uint32_t copy_dest;
        fd_flags_u flags;
        uint32_t data_crc;
        security_fd_flags_u security_flags;
        uint8_t image_tag[TT_BOOT_FS_IMAGE_TAG_SIZE];
        uint32_t fd_crc;
} tt_boot_fs_fd;
 
typedef int (*tt_boot_fs_read)(uint32_t addr, uint32_t size, uint8_t *dst);
typedef int (*tt_boot_fs_write)(uint32_t addr, uint32_t size, const uint8_t *src);
typedef int (*tt_boot_fs_erase)(uint32_t addr, uint32_t size);
 
typedef struct {
        tt_boot_fs_read hal_spi_read_f;
        tt_boot_fs_write hal_spi_write_f;
        tt_boot_fs_erase hal_spi_erase_f;
} tt_boot_fs;
 
enum {
        TT_BOOT_FS_OK = 0,
        TT_BOOT_FS_ERR = -1
};
 
typedef enum {
        TT_BOOT_FS_CHK_OK,
        TT_BOOT_FS_CHK_FAIL,
} tt_checksum_res_t;
 
extern tt_boot_fs boot_fs_data;
 
uint32_t tt_boot_fs_next(uint32_t prev);
 
int tt_boot_fs_mount(tt_boot_fs *tt_boot_fs, tt_boot_fs_read hal_read, tt_boot_fs_write hal_write,
                     tt_boot_fs_erase hal_erase);
 
int tt_boot_fs_add_file(const tt_boot_fs *tt_boot_fs, tt_boot_fs_fd fd_data,
                        const uint8_t *image_data_src, bool isFailoverEntry,
                        bool isSecurityBinaryEntry);
 
uint32_t tt_boot_fs_cksum(uint32_t cksum, const uint8_t *data, size_t size);
 
int tt_boot_fs_get_file(const tt_boot_fs *tt_boot_fs, const uint8_t *tag, uint8_t *buf,
                        size_t buf_size, size_t *file_size);

int tt_boot_fs_ls(const struct device *dev, tt_boot_fs_fd *fds, size_t nfds, size_t offset);

int tt_boot_fs_find_fd_by_tag(const struct device *flash_dev, const uint8_t *tag,
                              tt_boot_fs_fd *fd);
 
#ifdef __cplusplus
}
#endif
 
#endif