System module for Furiosa smi. More...

Functions
FuriosaSmiReturnCode	furiosa_smi_get_driver_info (FuriosaSmiVersion *out_driver_info)
	Get a driver information of Furiosa NPU device.

FuriosaSmiReturnCode	furiosa_smi_get_core_frequency (FuriosaSmiDeviceHandle handle, FuriosaSmiCoreFrequency *out_core_frequency_info)
	Get a core frequency of Furiosa NPU device.

FuriosaSmiReturnCode	furiosa_smi_get_memory_frequency (FuriosaSmiDeviceHandle handle, FuriosaSmiMemoryFrequency *out_memory_frequency_info)
	Get a memory frequency of Furiosa NPU device.

FuriosaSmiReturnCode	furiosa_smi_get_device_performance_counter (FuriosaSmiDeviceHandle handle, FuriosaSmiDevicePerformanceCounter *out_performance_counter_info)
	Get a performance counter of Furiosa NPU device.

FuriosaSmiReturnCode	furiosa_smi_get_device_power_consumption (FuriosaSmiDeviceHandle handle, FuriosaSmiDevicePowerConsumption *out_power_consumption)
	Get a power consumption of Furiosa NPU device.

FuriosaSmiReturnCode	furiosa_smi_get_device_temperature (FuriosaSmiDeviceHandle handle, FuriosaSmiDeviceTemperature *out_temperature)
	Get a power consumption of Furiosa NPU device.

FuriosaSmiReturnCode	furiosa_smi_get_governor_profile (FuriosaSmiDeviceHandle handle, FuriosaSmiGovernorProfile *out_governor_profile)
	Get a governor state of Furiosa NPU device.

FuriosaSmiReturnCode	furiosa_smi_set_governor_profile (FuriosaSmiDeviceHandle handle, FuriosaSmiGovernorProfile governor_profile)
	Set a governor state into Furiosa NPU device. This requires root privileges.

FuriosaSmiReturnCode	furiosa_smi_enable_device (FuriosaSmiDeviceHandle handle)
	Bind a Furiosa NPU device. This requires root privileges.

FuriosaSmiReturnCode	furiosa_smi_disable_device (FuriosaSmiDeviceHandle handle)
	Unbind a Furiosa NPU device. This requires root privileges.

FuriosaSmiReturnCode	furiosa_smi_get_disabled_devices (FuriosaSmiDisabledDevices *out_disabled_devices)
	Get a list of disabled Furiosa NPU devices.

FuriosaSmiReturnCode	furiosa_smi_get_pcie_device_info (FuriosaSmiDeviceHandle handle, FuriosaSmiPcieDeviceInfo *out_pcie_device_info)
	Get a PCIe information of Furiosa NPU device.

FuriosaSmiReturnCode	furiosa_smi_get_pcie_link_info (FuriosaSmiDeviceHandle handle, FuriosaSmiPcieLinkInfo *out_pcie_link_info)
	Get a PCIe link information of Furiosa NPU device.

FuriosaSmiReturnCode	furiosa_smi_get_sriov_info (FuriosaSmiDeviceHandle handle, FuriosaSmiSriovInfo *out_sriov_info)
	Get a SR-IOV information of Furiosa NPU device.

FuriosaSmiReturnCode	furiosa_smi_get_pcie_root_complex_info (FuriosaSmiDeviceHandle handle, FuriosaSmiPcieRootComplexInfo *out_root_complex_info)
	Get a PCIe root complex information of Furiosa NPU device.

FuriosaSmiReturnCode	furiosa_smi_get_pcie_switch_info (FuriosaSmiDeviceHandle handle, FuriosaSmiPcieSwitchInfo *out_pcie_switch_info)
	Get a PCIe switch information of Furiosa NPU device.

FuriosaSmiReturnCode	furiosa_smi_get_throttle_reason (FuriosaSmiDeviceHandle handle, FuriosaSmiThrottleReason *out_throttle_reason)
	Get a throttle reason of Furiosa NPU device.

Detailed Description

System module for Furiosa smi.

Function Documentation

◆ furiosa_smi_disable_device()

FuriosaSmiReturnCode furiosa_smi_disable_device ( FuriosaSmiDeviceHandle handle )

Unbind a Furiosa NPU device. This requires root privileges.

Parameters

handle handle of Furiosa NPU device.

Returns: FURIOSA_SMI_RETURN_CODE_OK if successful, see FuriosaSmiReturnCode for error cases.

◆ furiosa_smi_enable_device()

FuriosaSmiReturnCode furiosa_smi_enable_device ( FuriosaSmiDeviceHandle handle )

Bind a Furiosa NPU device. This requires root privileges.

Parameters

handle handle of Furiosa NPU device.

Returns: FURIOSA_SMI_RETURN_CODE_OK if successful, see FuriosaSmiReturnCode for error cases.

◆ furiosa_smi_get_core_frequency()

FuriosaSmiReturnCode furiosa_smi_get_core_frequency	(	FuriosaSmiDeviceHandle	handle,
		FuriosaSmiCoreFrequency *	out_core_frequency_info
	)

Get a core frequency of Furiosa NPU device.

Parameters

	handle	handle of Furiosa NPU device.
[out]	out_core_frequency_info	output buffer for pointer to FuriosaSmiCoreFrequency.

Returns: FURIOSA_SMI_RETURN_CODE_OK if successful, see FuriosaSmiReturnCode for error cases.

◆ furiosa_smi_get_device_performance_counter()

FuriosaSmiReturnCode furiosa_smi_get_device_performance_counter	(	FuriosaSmiDeviceHandle	handle,
		FuriosaSmiDevicePerformanceCounter *	out_performance_counter_info
	)

Get a performance counter of Furiosa NPU device.

Parameters

	handle	handle of Furiosa NPU device.
	core	core index of Furiosa NPU device.
[out]	out_performance_counter_info	output buffer for pointer to FuriosaSmiPePerformanceCounter.

Returns: FURIOSA_SMI_RETURN_CODE_OK if successful, see FuriosaSmiReturnCode for error cases.

◆ furiosa_smi_get_device_power_consumption()

FuriosaSmiReturnCode furiosa_smi_get_device_power_consumption	(	FuriosaSmiDeviceHandle	handle,
		FuriosaSmiDevicePowerConsumption *	out_power_consumption
	)

Get a power consumption of Furiosa NPU device.

Parameters

	handle	handle of Furiosa NPU device.
[out]	out_power_consumption	output buffer for pointer to FuriosaSmiDevicePowerConsumption.

Returns: FURIOSA_SMI_RETURN_CODE_OK if successful, see FuriosaSmiReturnCode for error cases.

◆ furiosa_smi_get_device_temperature()

FuriosaSmiReturnCode furiosa_smi_get_device_temperature	(	FuriosaSmiDeviceHandle	handle,
		FuriosaSmiDeviceTemperature *	out_temperature
	)

Get a power consumption of Furiosa NPU device.

Parameters

	handle	handle of Furiosa NPU device.
[out]	out_power_consumption	output buffer for pointer to FuriosaSmiDevicePowerConsumption.

Returns: FURIOSA_SMI_RETURN_CODE_OK if successful, see FuriosaSmiReturnCode for error cases.

◆ furiosa_smi_get_disabled_devices()

FuriosaSmiReturnCode furiosa_smi_get_disabled_devices ( FuriosaSmiDisabledDevices * out_disabled_devices )

Get a list of disabled Furiosa NPU devices.

Parameters

[out] out_disabled_devices output buffer for pointer to FuriosaSmiDisabledDevices.

Returns: FURIOSA_SMI_RETURN_CODE_OK if successful, see FuriosaSmiReturnCode for error cases.

◆ furiosa_smi_get_driver_info()

FuriosaSmiReturnCode furiosa_smi_get_driver_info ( FuriosaSmiVersion * out_driver_info )

Get a driver information of Furiosa NPU device.

Parameters

	handle	handle of Furiosa NPU device.
[out]	out_driver_info	output buffer for pointer to FuriosaSmiVersion.

Returns: FURIOSA_SMI_RETURN_CODE_OK if successful, see FuriosaSmiReturnCode for error cases.

◆ furiosa_smi_get_governor_profile()

FuriosaSmiReturnCode furiosa_smi_get_governor_profile	(	FuriosaSmiDeviceHandle	handle,
		FuriosaSmiGovernorProfile *	out_governor_profile
	)

Get a governor state of Furiosa NPU device.

Parameters

	handle	handle of Furiosa NPU device.
[out]	out_governor_profile	output buffer for pointer to FuriosaSmiGovernorProfile.

Returns: FURIOSA_SMI_RETURN_CODE_OK if successful, see FuriosaSmiReturnCode for error cases.

◆ furiosa_smi_get_memory_frequency()

FuriosaSmiReturnCode furiosa_smi_get_memory_frequency	(	FuriosaSmiDeviceHandle	handle,
		FuriosaSmiMemoryFrequency *	out_memory_frequency_info
	)

Get a memory frequency of Furiosa NPU device.

Parameters

	handle	handle of Furiosa NPU device.
[out]	out_memory_frequency_info	output buffer for pointer to FuriosaSmiMemoryFrequency.

Returns: FURIOSA_SMI_RETURN_CODE_OK if successful, see FuriosaSmiReturnCode for error cases.

◆ furiosa_smi_get_pcie_device_info()

FuriosaSmiReturnCode furiosa_smi_get_pcie_device_info	(	FuriosaSmiDeviceHandle	handle,
		FuriosaSmiPcieDeviceInfo *	out_pcie_device_info
	)

Get a PCIe information of Furiosa NPU device.

Parameters

	handle	handle of Furiosa NPU device.
[out]	out_pcie_device_info	output buffer for pointer to FuriosaSmiPcieDeviceInfo.

Returns: FURIOSA_SMI_RETURN_CODE_OK if successful, see FuriosaSmiReturnCode for error cases.

◆ furiosa_smi_get_pcie_link_info()

FuriosaSmiReturnCode furiosa_smi_get_pcie_link_info	(	FuriosaSmiDeviceHandle	handle,
		FuriosaSmiPcieLinkInfo *	out_pcie_link_info
	)

Get a PCIe link information of Furiosa NPU device.

Parameters

	handle	handle of Furiosa NPU device.
[out]	out_pcie_link_info	output buffer for pointer to FuriosaSmiPcieLinkInfo.

Returns: FURIOSA_SMI_RETURN_CODE_OK if successful, see FuriosaSmiReturnCode for error cases.

◆ furiosa_smi_get_pcie_root_complex_info()

FuriosaSmiReturnCode furiosa_smi_get_pcie_root_complex_info	(	FuriosaSmiDeviceHandle	handle,
		FuriosaSmiPcieRootComplexInfo *	out_root_complex_info
	)

Get a PCIe root complex information of Furiosa NPU device.

Parameters

	handle	handle of Furiosa NPU device.
[out]	out_root_complex_info	output buffer for pointer to FuriosaSmiPcieRootComplexInfo.

Returns: FURIOSA_SMI_RETURN_CODE_OK if successful, see FuriosaSmiReturnCode for error cases.

◆ furiosa_smi_get_pcie_switch_info()

FuriosaSmiReturnCode furiosa_smi_get_pcie_switch_info	(	FuriosaSmiDeviceHandle	handle,
		FuriosaSmiPcieSwitchInfo *	out_pcie_switch_info
	)

Get a PCIe switch information of Furiosa NPU device.

Parameters

	handle	handle of Furiosa NPU device.
[out]	out_pcie_switch_info	output buffer for pointer to FuriosaSmiPcieSwitchInfo.

Returns: FURIOSA_SMI_RETURN_CODE_OK if successful, see FuriosaSmiReturnCode for error cases.

◆ furiosa_smi_get_sriov_info()

FuriosaSmiReturnCode furiosa_smi_get_sriov_info	(	FuriosaSmiDeviceHandle	handle,
		FuriosaSmiSriovInfo *	out_sriov_info
	)

Get a SR-IOV information of Furiosa NPU device.

Parameters

	handle	handle of Furiosa NPU device.
[out]	out_sriov_info	output buffer for pointer to FuriosaSmiSriovInfo.

Returns: FURIOSA_SMI_RETURN_CODE_OK if successful, see FuriosaSmiReturnCode for error cases.

◆ furiosa_smi_get_throttle_reason()

FuriosaSmiReturnCode furiosa_smi_get_throttle_reason	(	FuriosaSmiDeviceHandle	handle,
		FuriosaSmiThrottleReason *	out_throttle_reason
	)

Get a throttle reason of Furiosa NPU device.

Parameters

	handle	handle of Furiosa NPU device.
[out]	out_throttle_reason	output buffer for pointer to FuriosaSmiThrottleReason.

Returns: FURIOSA_SMI_RETURN_CODE_OK if successful, see FuriosaSmiReturnCode for error cases.

◆ furiosa_smi_set_governor_profile()

FuriosaSmiReturnCode furiosa_smi_set_governor_profile	(	FuriosaSmiDeviceHandle	handle,
		FuriosaSmiGovernorProfile	governor_profile
	)

Set a governor state into Furiosa NPU device. This requires root privileges.

Parameters

	handle	handle of Furiosa NPU device.
[in]	governor_profile	input buffer for pointer to FuriosaSmiGovernorProfile.

Returns: FURIOSA_SMI_RETURN_CODE_OK if successful, see FuriosaSmiReturnCode for error cases.

Functions

Detailed Description

Function Documentation

◆ furiosa_smi_disable_device()

◆ furiosa_smi_enable_device()

◆ furiosa_smi_get_core_frequency()

◆ furiosa_smi_get_device_performance_counter()

◆ furiosa_smi_get_device_power_consumption()

◆ furiosa_smi_get_device_temperature()

◆ furiosa_smi_get_disabled_devices()

◆ furiosa_smi_get_driver_info()

◆ furiosa_smi_get_governor_profile()

◆ furiosa_smi_get_memory_frequency()

◆ furiosa_smi_get_pcie_device_info()

◆ furiosa_smi_get_pcie_link_info()

◆ furiosa_smi_get_pcie_root_complex_info()

◆ furiosa_smi_get_pcie_switch_info()

◆ furiosa_smi_get_sriov_info()

◆ furiosa_smi_get_throttle_reason()

◆ furiosa_smi_set_governor_profile()