bh_fwtable.h

Go to the documentation of this file.

/*
 * Copyright (c) 2025 Tenstorrent AI ULC
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef BH_FWTABLE_H
#define BH_FWTABLE_H
 
#include <stdbool.h>
#include <stdint.h>
#include <zephyr/device.h>
#include <zephyr/sys/util.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*
 * The generated nanopb headers only exist when the bh_fwtable driver is built.
 * SMC recovery builds disable the driver (see drivers/misc/bh_fwtable/Kconfig),
 * but still pull in this header transitively for the plain chip enums below
 * (e.g. PcbType via regulator.h).
 */
#ifdef CONFIG_BH_FWTABLE
#include "fw_table.pb.h"
#include "flash_info.pb.h"
#include "read_only.pb.h"
#endif
 
const struct _FwTable *tt_bh_fwtable_get_fw_table(const struct device *dev);
const struct _FlashInfoTable *tt_bh_fwtable_get_flash_info_table(const struct device *dev);
const struct _ReadOnly *tt_bh_fwtable_get_read_only_table(const struct device *dev);
uint64_t tt_bh_fwtable_get_legacy_board_id(const struct device *dev);
 
/* Board type values extracted from board_id (bits 36-55, up to 5 hex digits) */
#define BOARDTYPE_FROM_BOARD_ID(board_id) ((uint32_t)(((board_id) >> 36) & 0xFFFFF))
/*
 * Extended board IDs encode the part number in the upper 8 hex digits. The
 * board type occupies the middle 5 hex digits of that part number.
 */
#define BOARDTYPE_FROM_EXTENDED_BOARD_ID(board_id_high, board_id)                                  \
        ((uint32_t)(((((uint32_t)(board_id_high) << 16) |                                          \
                      (uint32_t)((uint64_t)(board_id) >> 48)) >>                                   \
                     4) &                                                                          \
                    0xFFFFF))
#define BOARDTYPE_ORION_SLT 0x37
#define BOARDTYPE_P100A     0x43
#define BOARDTYPE_P150A     0x40
#define BOARDTYPE_P150      0x41
#define BOARDTYPE_P150C     0x42
#define BOARDTYPE_P300      0x44
#define BOARDTYPE_P300A     0x45
#define BOARDTYPE_P300C     0x46
#define BOARDTYPE_UBB       0x47
#define BOARDTYPE_GALAXY2   0x78
#define BOARDTYPE_GALAXY_CF 0x202
 
typedef enum {
        PcbTypeOrionSLT = 0,
        PcbTypeP100 = 1,
        PcbTypeP150 = 2,
        PcbTypeP300 = 3,
        PcbTypeUBB = 4,
        PcbTypeGalaxy2 = 5,
        PcbTypeUnknown = 0xFF
} PcbType;
 
PcbType tt_bh_fwtable_get_pcb_type(const struct device *dev);
uint32_t tt_bh_fwtable_get_board_type(const struct device *dev);
bool tt_bh_fwtable_is_p300_left_chip(void);
uint32_t tt_bh_fwtable_get_asic_location(const struct device *dev);
void tt_bh_fwtable_apply_ccfgovr(const struct device *dev);
 
/*
 * Outcome of the boot-time ccfgovr merge, one 2-bit state per bank, as
 * returned by tt_bh_fwtable_get_ccfgovr_state() and published in
 * TAG_CCFGOVR_STATE.
 */
#define BH_FWTABLE_CCFGOVR_BANK_EMPTY    0U /* no plausible header */
#define BH_FWTABLE_CCFGOVR_BANK_STANDBY  1U /* plausible header, never loaded */
#define BH_FWTABLE_CCFGOVR_BANK_REJECTED 2U /* failed CRC or protobuf decode */
#define BH_FWTABLE_CCFGOVR_BANK_APPLIED  3U
 
#define BH_FWTABLE_CCFGOVR_STATE_BANK_A        GENMASK(1, 0)
#define BH_FWTABLE_CCFGOVR_STATE_BANK_B        GENMASK(3, 2)
/* The applied bank has a non-empty override body */
#define BH_FWTABLE_CCFGOVR_STATE_HAS_OVERRIDES BIT(4)
 
uint32_t tt_bh_fwtable_get_ccfgovr_state(const struct device *dev);
/* Sequence number of the applied bank; 0 when no bank was applied */
uint32_t tt_bh_fwtable_get_ccfgovr_seq(const struct device *dev);
 
#ifdef __cplusplus
}
#endif
 
#endif /* BH_FWTABLE_H*/