furiosa_smi.h

Go to the documentation of this file.

#ifndef __furiosa_smi_h__
#define __furiosa_smi_h__
 
#include <stdarg.h>
#include <stdbool.h>
#include <stdint.h>
#include <stdlib.h>
 
#define FURIOSA_SMI_MAX_PATH_SIZE 256
 
#define FURIOSA_SMI_MAX_DEVICE_FILE_SIZE 64
 
#define FURIOSA_SMI_MAX_CORE_STATUS_SIZE 128
 
#define FURIOSA_SMI_MAX_PE_SIZE 64
 
#define FURIOSA_SMI_MAX_DEVICE_HANDLE_SIZE 64
 
#define FURIOSA_SMI_MAX_CSTR_SIZE 96
 
typedef enum {
  FURIOSA_SMI_ARCH_WARBOY = 0,
  FURIOSA_SMI_ARCH_RNGD,
  FURIOSA_SMI_ARCH_RNGD_MAX,
  FURIOSA_SMI_ARCH_RNGD_S,
} FuriosaSmiArch;
 
typedef enum {
  FURIOSA_SMI_CORE_STATUS_AVAILABLE = 0,
  FURIOSA_SMI_CORE_STATUS_OCCUPIED,
} FuriosaSmiCoreStatus;
 
typedef enum {
  FURIOSA_SMI_DEVICE_TO_DEVICE_LINK_TYPE_UNKNOWN = 0,
  FURIOSA_SMI_DEVICE_TO_DEVICE_LINK_TYPE_INTERCONNECT = 10,
  FURIOSA_SMI_DEVICE_TO_DEVICE_LINK_TYPE_CPU = 20,
  FURIOSA_SMI_DEVICE_TO_DEVICE_LINK_TYPE_BRIDGE = 30,
  FURIOSA_SMI_DEVICE_TO_DEVICE_LINK_TYPE_NOC = 70,
} FuriosaSmiDeviceToDeviceLinkType;
 
typedef enum {
  FURIOSA_SMI_GOVERNOR_PROFILE_PERFORMANCE = 0,
  FURIOSA_SMI_GOVERNOR_PROFILE_POWER_SAVE,
} FuriosaSmiGovernorProfile;
 
typedef enum {
  FURIOSA_SMI_RETURN_CODE_OK = 0,
  FURIOSA_SMI_RETURN_CODE_INVALID_ARGUMENT_ERROR,
  FURIOSA_SMI_RETURN_CODE_NULL_POINTER_ERROR,
  FURIOSA_SMI_RETURN_CODE_MAX_BUFFER_SIZE_EXCEED_ERROR,
  FURIOSA_SMI_RETURN_CODE_DEVICE_NOT_FOUND_ERROR,
  FURIOSA_SMI_RETURN_CODE_DEVICE_LOST_ERROR,
  FURIOSA_SMI_RETURN_CODE_DEVICE_BUSY_ERROR,
  FURIOSA_SMI_RETURN_CODE_IO_ERROR,
  FURIOSA_SMI_RETURN_CODE_PERMISSION_DENIED_ERROR,
  FURIOSA_SMI_RETURN_CODE_UNKNOWN_ARCH_ERROR,
  FURIOSA_SMI_RETURN_CODE_INCOMPATIBLE_DRIVER_ERROR,
  FURIOSA_SMI_RETURN_CODE_UNEXPECTED_VALUE_ERROR,
  FURIOSA_SMI_RETURN_CODE_PARSE_ERROR,
  FURIOSA_SMI_RETURN_CODE_UNKNOWN_ERROR,
  FURIOSA_SMI_RETURN_CODE_INTERNAL_ERROR,
  FURIOSA_SMI_RETURN_CODE_UNINITIALIZED_ERROR,
  FURIOSA_SMI_RETURN_CODE_CONTEXT_ERROR,
  FURIOSA_SMI_RETURN_CODE_NOT_SUPPORTED_ERROR,
} FuriosaSmiReturnCode;
 
typedef uint32_t FuriosaSmiDeviceHandle;
 
typedef struct {
  uint32_t count;
  FuriosaSmiDeviceHandle device_handles[FURIOSA_SMI_MAX_DEVICE_HANDLE_SIZE];
} FuriosaSmiDeviceHandles;
 
typedef struct {
  uint32_t major;
  uint32_t minor;
  uint32_t patch;
  char metadata[FURIOSA_SMI_MAX_CSTR_SIZE];
} FuriosaSmiVersion;
 
typedef struct {
  uint32_t index;
  FuriosaSmiArch arch;
  uint32_t core_num;
  uint32_t numa_node;
  char name[FURIOSA_SMI_MAX_CSTR_SIZE];
  char serial[FURIOSA_SMI_MAX_CSTR_SIZE];
  char uuid[FURIOSA_SMI_MAX_CSTR_SIZE];
  char bdf[FURIOSA_SMI_MAX_CSTR_SIZE];
  uint16_t major;
  uint16_t minor;
  FuriosaSmiVersion firmware_version;
} FuriosaSmiDeviceInfo;
 
typedef struct {
  uint32_t core_start;
  uint32_t core_end;
  char path[FURIOSA_SMI_MAX_PATH_SIZE];
} FuriosaSmiDeviceFile;
 
typedef struct {
  uint32_t count;
  FuriosaSmiDeviceFile device_files[FURIOSA_SMI_MAX_DEVICE_HANDLE_SIZE];
} FuriosaSmiDeviceFiles;
 
typedef struct {
  uint32_t core;
  FuriosaSmiCoreStatus status;
} FuriosaSmiPeStatus;
 
typedef struct {
  uint32_t count;
  FuriosaSmiPeStatus core_status[FURIOSA_SMI_MAX_CORE_STATUS_SIZE];
} FuriosaSmiCoreStatuses;
 
typedef struct {
  uint32_t core;
  uint32_t frequency;
} FuriosaSmiPeFrequency;
 
typedef struct {
  uint32_t pe_count;
  FuriosaSmiPeFrequency pe[FURIOSA_SMI_MAX_PE_SIZE];
} FuriosaSmiCoreFrequency;
 
typedef struct {
  uint32_t frequency;
} FuriosaSmiMemoryFrequency;
 
typedef struct {
  long timestamp;
  uint32_t core;
  uint64_t cycle_count;
  uint64_t task_execution_cycle;
} FuriosaSmiPePerformanceCounter;
 
typedef struct {
  uint32_t pe_count;
  FuriosaSmiPePerformanceCounter pe_performance_counters[FURIOSA_SMI_MAX_PE_SIZE];
} FuriosaSmiDevicePerformanceCounter;
 
typedef struct {
  double rms_total;
} FuriosaSmiDevicePowerConsumption;
 
typedef struct {
  double soc_peak;
  double ambient;
} FuriosaSmiDeviceTemperature;
 
typedef char FuriosaSmiBdf[FURIOSA_SMI_MAX_CSTR_SIZE];
 
typedef struct {
  uint32_t count;
  FuriosaSmiBdf bdfs[FURIOSA_SMI_MAX_DEVICE_HANDLE_SIZE];
} FuriosaSmiDisabledDevices;
 
typedef struct {
  uint16_t device_id;
  uint16_t subsystem_vendor_id;
  uint16_t subsystem_device_id;
  uint8_t revision_id;
  uint8_t class_id;
  uint8_t sub_class_id;
} FuriosaSmiPcieDeviceInfo;
 
typedef struct {
  uint8_t pcie_gen_status;
  uint32_t link_width_status;
  double link_speed_status;
  uint32_t max_link_width_capability;
  double max_link_speed_capability;
} FuriosaSmiPcieLinkInfo;
 
typedef struct {
  uint32_t sriov_total_vfs;
  uint32_t sriov_enabled_vfs;
} FuriosaSmiSriovInfo;
 
typedef struct {
  uint16_t domain;
  uint8_t bus;
} FuriosaSmiPcieRootComplexInfo;
 
typedef struct {
  uint16_t domain;
  uint8_t bus;
  uint8_t device;
  uint8_t function;
} FuriosaSmiPcieSwitchInfo;
 
 
FuriosaSmiReturnCode furiosa_smi_init(void);
 
 
 
FuriosaSmiReturnCode furiosa_smi_get_device_handles(FuriosaSmiDeviceHandles *out_handles);
 
FuriosaSmiReturnCode furiosa_smi_get_device_handle_by_uuid(const char *uuid,
                                                           FuriosaSmiDeviceHandle *out_handle);
 
FuriosaSmiReturnCode furiosa_smi_get_device_handle_by_serial(const char *serial,
                                                             FuriosaSmiDeviceHandle *out_handle);
 
FuriosaSmiReturnCode furiosa_smi_get_device_handle_by_bdf(const char *bdf,
                                                          FuriosaSmiDeviceHandle *out_handle);
 
FuriosaSmiReturnCode furiosa_smi_get_device_info(FuriosaSmiDeviceHandle handle,
                                                 FuriosaSmiDeviceInfo *out_device_info);
 
FuriosaSmiReturnCode furiosa_smi_get_device_files(FuriosaSmiDeviceHandle handle,
                                                  FuriosaSmiDeviceFiles *out_device_files);
 
FuriosaSmiReturnCode furiosa_smi_get_device_core_status(FuriosaSmiDeviceHandle handle,
                                                        FuriosaSmiCoreStatuses *out_core_status);
 
FuriosaSmiReturnCode furiosa_smi_get_device_liveness(FuriosaSmiDeviceHandle handle,
                                                     bool *out_liveness);
 
 
 
FuriosaSmiReturnCode furiosa_smi_get_device_to_device_link_type(FuriosaSmiDeviceHandle handle1,
                                                                FuriosaSmiDeviceHandle handle2,
                                                                FuriosaSmiDeviceToDeviceLinkType *out_link_type);
 
FuriosaSmiReturnCode furiosa_smi_get_p2p_accessible(FuriosaSmiDeviceHandle handle1,
                                                    FuriosaSmiDeviceHandle handle2,
                                                    bool *out_accessible);
 
 
 
FuriosaSmiReturnCode furiosa_smi_get_driver_info(FuriosaSmiVersion *out_driver_info);
 
FuriosaSmiReturnCode furiosa_smi_get_core_frequency(FuriosaSmiDeviceHandle handle,
                                                    FuriosaSmiCoreFrequency *out_core_frequency_info);
 
FuriosaSmiReturnCode furiosa_smi_get_memory_frequency(FuriosaSmiDeviceHandle handle,
                                                      FuriosaSmiMemoryFrequency *out_memory_frequency_info);
 
FuriosaSmiReturnCode furiosa_smi_get_device_performance_counter(FuriosaSmiDeviceHandle handle,
                                                                FuriosaSmiDevicePerformanceCounter *out_performance_counter_info);
 
FuriosaSmiReturnCode furiosa_smi_get_device_power_consumption(FuriosaSmiDeviceHandle handle,
                                                              FuriosaSmiDevicePowerConsumption *out_power_consumption);
 
FuriosaSmiReturnCode furiosa_smi_get_device_temperature(FuriosaSmiDeviceHandle handle,
                                                        FuriosaSmiDeviceTemperature *out_temperature);
 
FuriosaSmiReturnCode furiosa_smi_get_governor_profile(FuriosaSmiDeviceHandle handle,
                                                      FuriosaSmiGovernorProfile *out_governor_profile);
 
FuriosaSmiReturnCode furiosa_smi_set_governor_profile(FuriosaSmiDeviceHandle handle,
                                                      FuriosaSmiGovernorProfile governor_profile);
 
FuriosaSmiReturnCode furiosa_smi_enable_device(FuriosaSmiDeviceHandle handle);
 
FuriosaSmiReturnCode furiosa_smi_disable_device(FuriosaSmiDeviceHandle handle);
 
FuriosaSmiReturnCode furiosa_smi_get_disabled_devices(FuriosaSmiDisabledDevices *out_disabled_devices);
 
FuriosaSmiReturnCode furiosa_smi_get_pcie_device_info(FuriosaSmiDeviceHandle handle,
                                                      FuriosaSmiPcieDeviceInfo *out_pcie_device_info);
 
FuriosaSmiReturnCode furiosa_smi_get_pcie_link_info(FuriosaSmiDeviceHandle handle,
                                                    FuriosaSmiPcieLinkInfo *out_pcie_link_info);
 
FuriosaSmiReturnCode furiosa_smi_get_sriov_info(FuriosaSmiDeviceHandle handle,
                                                FuriosaSmiSriovInfo *out_sriov_info);
 
FuriosaSmiReturnCode furiosa_smi_get_pcie_root_complex_info(FuriosaSmiDeviceHandle handle,
                                                            FuriosaSmiPcieRootComplexInfo *out_root_complex_info);
 
FuriosaSmiReturnCode furiosa_smi_get_pcie_switch_info(FuriosaSmiDeviceHandle handle,
                                                      FuriosaSmiPcieSwitchInfo *out_pcie_switch_info);
 
 
 
 
#endif /* __furiosa_smi_h__ */