TT Zephyr Platforms 19.5.0-rc1
Tenstorrent Firmware
Loading...
Searching...
No Matches
Host Message Interface

Interface for handling host request and response messages between the Tenstorrent host and ARC processor. More...

Data Structures

struct  force_fan_speed_rqst
 Host request to force the fan speed. More...
struct  aiclk_set_speed_rqst
 Host request to adjust the AICLK speed. More...
struct  power_setting_rqst
 Host request to adjust the power settings. More...
struct  set_voltage_rqst
 Host request to set voltage. More...
struct  get_voltage_rqst
 Host request to get voltage. More...
struct  switch_vout_control_rqst
 Host request to switch VOUT control. More...
struct  switch_clk_scheme_rqst
 Host request to switch clock scheme. More...
struct  get_freq_curve_from_voltage_rqst
 Host request to get frequency curve from voltage. More...
struct  get_voltage_curve_from_freq_rqst
 Host request to get voltage curve from frequency. More...
struct  debug_noc_translation_rqst
 Host request for debug NOC translation. More...
struct  dmc_ping_rqst
 Host request to ping DMC. More...
struct  send_pcie_msi_rqst
 Host request to send PCIE MSI. More...
struct  i2c_message_rqst
 Host request for I2C message transaction. More...
 Host request to blink the LED. More...
struct  test_rqst
 Host request for test message. More...
struct  asic_state_rqst
 Host request to change ASIC state. More...
union  request
 A tenstorrent host request. More...

Enumerations

enum  tt_smc_msg {
  TT_SMC_MSG_RESERVED_01 = 0x1 ,
  TT_SMC_MSG_NOP = 0x11 ,
  TT_SMC_MSG_SET_VOLTAGE = 0x12 ,
  TT_SMC_MSG_GET_VOLTAGE = 0x13 ,
  TT_SMC_MSG_SWITCH_CLK_SCHEME = 0x14 ,
  TT_SMC_MSG_DEBUG_NOC_TRANSLATION = 0x15 ,
  TT_SMC_MSG_REPORT_SCRATCH_ONLY = 0x16 ,
  TT_SMC_MSG_SEND_PCIE_MSI = 0x17 ,
  TT_SMC_MSG_SWITCH_VOUT_CONTROL = 0x18 ,
  TT_SMC_MSG_READ_EEPROM = 0x19 ,
  TT_SMC_MSG_WRITE_EEPROM = 0x1A ,
  TT_SMC_MSG_READ_TS = 0x1B ,
  TT_SMC_MSG_READ_PD = 0x1C ,
  TT_SMC_MSG_READ_VM = 0x1D ,
  TT_SMC_MSG_I2C_MESSAGE = 0x1E ,
  TT_SMC_MSG_EFUSE_BURN_BITS = 0x1F ,
  TT_SMC_MSG_REINIT_TENSIX = 0x20 ,
  TT_SMC_MSG_POWER_SETTING = 0x21 ,
  TT_SMC_MSG_GET_FREQ_CURVE_FROM_VOLTAGE = 0x30 ,
  TT_SMC_MSG_AISWEEP_START = 0x31 ,
  TT_SMC_MSG_AISWEEP_STOP = 0x32 ,
  TT_SMC_MSG_FORCE_AICLK = 0x33 ,
  TT_SMC_MSG_GET_AICLK = 0x34 ,
  TT_SMC_MSG_FORCE_VDD = 0x39 ,
  TT_SMC_MSG_PCIE_INDEX = 0x51 ,
  TT_SMC_MSG_AICLK_GO_BUSY = 0x52 ,
  TT_SMC_MSG_AICLK_GO_LONG_IDLE = 0x54 ,
  TT_SMC_MSG_TRIGGER_RESET = 0x56 ,
  TT_SMC_MSG_RESERVED_60 = 0x60 ,
  TT_SMC_MSG_TEST = 0x90 ,
  TT_SMC_MSG_PCIE_DMA_CHIP_TO_HOST_TRANSFER = 0x9B ,
  TT_SMC_MSG_PCIE_DMA_HOST_TO_CHIP_TRANSFER = 0x9C ,
  TT_SMC_MSG_PCIE_ERROR_CNT_RESET = 0x9D ,
  TT_SMC_MSG_TRIGGER_IRQ = 0x9F ,
  TT_SMC_MSG_ASIC_STATE0 = 0xA0 ,
  TT_SMC_MSG_ASIC_STATE1 = 0xA1 ,
  TT_SMC_MSG_ASIC_STATE3 = 0xA3 ,
  TT_SMC_MSG_ASIC_STATE5 = 0xA5 ,
  TT_SMC_MSG_GET_VOLTAGE_CURVE_FROM_FREQ = 0xA6 ,
  TT_SMC_MSG_FORCE_FAN_SPEED = 0xAC ,
  TT_SMC_MSG_GET_DRAM_TEMPERATURE = 0xAD ,
  TT_SMC_MSG_TOGGLE_TENSIX_RESET = 0xAF ,
  TT_SMC_MSG_DRAM_BIST_START = 0xB0 ,
  TT_SMC_MSG_NOC_WRITE_WORD = 0xB1 ,
  TT_SMC_MSG_TOGGLE_ETH_RESET = 0xB2 ,
  TT_SMC_MSG_SET_DRAM_REFRESH_RATE = 0xB3 ,
  TT_SMC_MSG_ARC_DMA = 0xB4 ,
  TT_SMC_MSG_TEST_SPI = 0xB5 ,
  TT_SMC_MSG_CURR_DATE = 0xB7 ,
  TT_SMC_MSG_UPDATE_M3_AUTO_RESET_TIMEOUT = 0xBC ,
  TT_SMC_MSG_CLEAR_NUM_AUTO_RESET = 0xBD ,
  TT_SMC_MSG_SET_LAST_SERIAL = 0xBE ,
  TT_SMC_MSG_EFUSE_BURN = 0xBF ,
  TT_SMC_MSG_PING_DM = 0xC0 ,
  TT_SMC_MSG_SET_WDT_TIMEOUT = 0xC1 ,
  TT_SMC_MSG_FLASH_UNLOCK = 0xC2 ,
  TT_SMC_MSG_FLASH_LOCK = 0xC3 ,
  TT_SMC_MSG_CONFIRM_FLASHED_SPI = 0xC4 ,
  TT_SMC_MSG_BLINKY = 0xC5
}
 Enumeration listing the available host requests IDs the SMC can process. More...

Detailed Description

Interface for handling host request and response messages between the Tenstorrent host and ARC processor.

The host will send a request, specifying the request::command_code (of type tt_smc_msg) SMC firmware will parse this message and send back a response.

Specific types of requests are parsed via the union members of request and documented therein.

Enumeration Type Documentation

◆ tt_smc_msg

enum tt_smc_msg

Enumeration listing the available host requests IDs the SMC can process.

Enumerator
TT_SMC_MSG_RESERVED_01 0x1 

Reserved.

TT_SMC_MSG_NOP 0x11 

No-op request (not supported)

TT_SMC_MSG_SET_VOLTAGE 0x12 

Set voltage request

TT_SMC_MSG_GET_VOLTAGE 0x13 

Get voltage request

TT_SMC_MSG_SWITCH_CLK_SCHEME 0x14 

Switch clock scheme request

TT_SMC_MSG_DEBUG_NOC_TRANSLATION 0x15 

Debug NOC translation request

TT_SMC_MSG_REPORT_SCRATCH_ONLY 0x16 
TT_SMC_MSG_SEND_PCIE_MSI 0x17 

Send PCIe MSI request

TT_SMC_MSG_SWITCH_VOUT_CONTROL 0x18 

Switch VOUT control request

TT_SMC_MSG_READ_EEPROM 0x19 
TT_SMC_MSG_WRITE_EEPROM 0x1A 
TT_SMC_MSG_READ_TS 0x1B 
TT_SMC_MSG_READ_PD 0x1C 
TT_SMC_MSG_READ_VM 0x1D 
TT_SMC_MSG_I2C_MESSAGE 0x1E 

I2C message request

TT_SMC_MSG_EFUSE_BURN_BITS 0x1F 

eFuse burn bits request (not supported)

TT_SMC_MSG_REINIT_TENSIX 0x20 
TT_SMC_MSG_POWER_SETTING 0x21 

Power Setting Request

TT_SMC_MSG_GET_FREQ_CURVE_FROM_VOLTAGE 0x30 

Frequency Curve from Voltage Request

TT_SMC_MSG_AISWEEP_START 0x31 
TT_SMC_MSG_AISWEEP_STOP 0x32 
TT_SMC_MSG_FORCE_AICLK 0x33 
TT_SMC_MSG_GET_AICLK 0x34 
TT_SMC_MSG_FORCE_VDD 0x39 
TT_SMC_MSG_PCIE_INDEX 0x51 

PCIe index request (not supported)

TT_SMC_MSG_AICLK_GO_BUSY 0x52 

AI Clock Set Busy Speed Request

TT_SMC_MSG_AICLK_GO_LONG_IDLE 0x54 

AI Clock Set Idle Speed Request

TT_SMC_MSG_TRIGGER_RESET 0x56 
TT_SMC_MSG_RESERVED_60 0x60 

Reserved.

TT_SMC_MSG_TEST 0x90 

Test request

TT_SMC_MSG_PCIE_DMA_CHIP_TO_HOST_TRANSFER 0x9B 
TT_SMC_MSG_PCIE_DMA_HOST_TO_CHIP_TRANSFER 0x9C 
TT_SMC_MSG_PCIE_ERROR_CNT_RESET 0x9D 

PCIe error count reset request (not supported)

TT_SMC_MSG_TRIGGER_IRQ 0x9F 

Trigger IRQ request (not supported)

TT_SMC_MSG_ASIC_STATE0 0xA0 

ASIC State 0 (A0State) request

TT_SMC_MSG_ASIC_STATE1 0xA1 

ASIC state 1 request (not supported)

TT_SMC_MSG_ASIC_STATE3 0xA3 

ASIC State 3 (A3State) request

TT_SMC_MSG_ASIC_STATE5 0xA5 

ASIC state 5 request (not supported)

TT_SMC_MSG_GET_VOLTAGE_CURVE_FROM_FREQ 0xA6 

Voltage Curve from Frequency Request

TT_SMC_MSG_FORCE_FAN_SPEED 0xAC 

Force Fan Speed Request

TT_SMC_MSG_GET_DRAM_TEMPERATURE 0xAD 

Get DRAM temperature request (not supported)

TT_SMC_MSG_TOGGLE_TENSIX_RESET 0xAF 
TT_SMC_MSG_DRAM_BIST_START 0xB0 

DRAM BIST start request (not supported)

TT_SMC_MSG_NOC_WRITE_WORD 0xB1 

NOC write word request (not supported)

TT_SMC_MSG_TOGGLE_ETH_RESET 0xB2 

Toggle Ethernet reset request (not supported)

TT_SMC_MSG_SET_DRAM_REFRESH_RATE 0xB3 

Set DRAM refresh rate request (not supported)

TT_SMC_MSG_ARC_DMA 0xB4 

ARC DMA request (not supported)

TT_SMC_MSG_TEST_SPI 0xB5 

Test SPI request (not supported)

TT_SMC_MSG_CURR_DATE 0xB7 

Current date request (not supported)

TT_SMC_MSG_UPDATE_M3_AUTO_RESET_TIMEOUT 0xBC 

Update M3 auto reset timeout request (not supported)

TT_SMC_MSG_CLEAR_NUM_AUTO_RESET 0xBD 

Clear number of auto resets request (not supported)

TT_SMC_MSG_SET_LAST_SERIAL 0xBE 
TT_SMC_MSG_EFUSE_BURN 0xBF 

eFuse burn request (not supported)

TT_SMC_MSG_PING_DM 0xC0 

Ping DMC request.

TT_SMC_MSG_SET_WDT_TIMEOUT 0xC1 
TT_SMC_MSG_FLASH_UNLOCK 0xC2 

Flash write unlock request.

TT_SMC_MSG_FLASH_LOCK 0xC3 

Flash write lock request.

TT_SMC_MSG_CONFIRM_FLASHED_SPI 0xC4 

Confirm SPI flash succeeded.

TT_SMC_MSG_BLINKY 0xC5 

Toggle red blinky on the board.