Python API provides Mobilint NPU monitoring and telemetry. More...

Classes
class	mbltml.mbltml.MBLTMLDriverNotFoundError
	Raised when the required driver cannot be located. More...
class	mbltml.mbltml.MBLTMLInvalidArgumentError
	Raised when one or more arguments are invalid. More...
class	mbltml.mbltml.MBLTMLUninitializedError
	Raised when an API is called before initialization. More...
class	mbltml.mbltml.MBLTMLNotSupportedError
	Raised when the feature is not supported on the target device. More...
class	mbltml.mbltml.MBLTMLInsufficientLengthError
	Raised when the output buffer is too small to hold the result. More...

Functions
None	mbltml.mbltml._loadLibrary ()
None	mbltml.mbltml._mbltmlThrowError (mbltmlStatusCode_t ret)
None	mbltml.mbltml.mbltmlInit ()
	Initialize the mbltml library for all supported device types.
None	mbltml.mbltml.mbltmlInitDevices (Set[mbltmlDeviceType_t] device_types)
	Initialize the mbltml library for a selected set of device types.
None	mbltml.mbltml.mbltmlShutdown ()
	Release all resources held by the mbltml library.
int	mbltml.mbltml.mbltmlGetDeviceCount ()
	Get the total number of devices detected by the library.
str	mbltml.mbltml.mbltmlGetDriverVersion (mbltmlDeviceType_t device_type)
	Get the driver version string for a specific device family.
int	mbltml.mbltml.mbltmlGetDriverRevision (mbltmlDeviceType_t device_type)
	Get the driver revision number for a specific device family.
str	mbltml.mbltml.mbltmlGetNodeName (int dev_no)
	Get the node name of a device.
mbltmlDeviceType_t	mbltml.mbltml.mbltmlGetDeviceType (int dev_no)
	Get the device family type of a device.
mbltmlHardwareVersion_t	mbltml.mbltml.mbltmlGetHardwareVersion (int dev_no)
	Get the hardware version of a device.
str	mbltml.mbltml.mbltmlGetFirmwareVersion (int dev_no)
	Get the firmware version string of a device.
int	mbltml.mbltml.mbltmlGetFirmwareRevision (int dev_no)
	Get the firmware revision number of a device.
int	mbltml.mbltml.mbltmlGetFirmwareCRC (int dev_no)
	Get the CRC of the currently-loaded firmware image.
int	mbltml.mbltml.mbltmlGetTemperature (int dev_no)
	Get the current die temperature of a device.
int	mbltml.mbltml.mbltmlGetSignalType (int dev_no)
	Get the current signal-type indicator reported by the device.
int	mbltml.mbltml.mbltmlGetNPUClock (int dev_no)
	Get the current NPU clock frequency of a device.
int	mbltml.mbltml.mbltmlGetBusClock (int dev_no)
	Get the current bus clock frequency of a device.
int	mbltml.mbltml.mbltmlGetFanDuty (int dev_no)
	Get the current cooling-fan duty cycle of a device.
int	mbltml.mbltml.mbltmlGetVendorId (int dev_no)
	Get the PCIe vendor ID of a device.
int	mbltml.mbltml.mbltmlGetDeviceId (int dev_no)
	Get the PCIe device ID of a device.
int	mbltml.mbltml.mbltmlGetSubVendorId (int dev_no)
	Get the PCIe subsystem vendor ID of a device.
int	mbltml.mbltml.mbltmlGetSubDeviceId (int dev_no)
	Get the PCIe subsystem device ID of a device.
int	mbltml.mbltml.mbltmlGetPcieGen (int dev_no)
	Get the negotiated PCIe link generation of a device.
int	mbltml.mbltml.mbltmlGetPcieLanes (int dev_no)
	Get the negotiated PCIe link width (in lanes) of a device.
int	mbltml.mbltml.mbltmlGetPcieRev (int dev_no)
	Get the PCIe configuration-space revision ID of a device.
int	mbltml.mbltml.mbltmlGetPcieClassCode (int dev_no)
	Get the PCIe configuration-space class code of a device.
float	mbltml.mbltml.mbltmlGetTotalPower (int dev_no)
	Get the total instantaneous power consumption of a device (W).
float	mbltml.mbltml.mbltmlGetTotalCurrent (int dev_no)
	Get the total instantaneous current draw of a device (A).
float	mbltml.mbltml.mbltmlGetTotalVoltage (int dev_no)
	Get the total instantaneous supply voltage of a device (V).
float	mbltml.mbltml.mbltmlGetExtraPmicPower (int dev_no)
	Get the power consumption of the extra PMIC rail currently selected for the device (W).
float	mbltml.mbltml.mbltmlGetExtraPmicCurrent (int dev_no)
	Get the current of the extra PMIC rail currently selected for the device (A).
float	mbltml.mbltml.mbltmlGetExtraPmicVoltage (int dev_no)
	Get the voltage of the extra PMIC rail currently selected for the device (V).
mbltmlExtraPmicId_t	mbltml.mbltml.mbltmlGetExtraPmicId (int dev_no)
	Get the extra PMIC rail currently selected for the device.
float	mbltml.mbltml.mbltmlGetTotalUtilization (int dev_no)
	Get the overall NPU utilization of a device.
int	mbltml.mbltml.mbltmlGetMemoryUsage (int dev_no)
	Get the amount of device memory currently in use.
int	mbltml.mbltml.mbltmlGetMemoryTotal (int dev_no)
	Get the total amount of device memory available.
List[mbltmlProcessInfo_t]	mbltml.mbltml.mbltmlGetProcessInfos (int dev_no)
	Get per-process usage information for a device.
List[mbltmlCoreInfo_t]	mbltml.mbltml.mbltmlGetCoreInfos (int dev_no)
	Get per-core usage information for a device.
None	mbltml.mbltml.mbltmlSetExtraPmicID (int dev_no, mbltmlExtraPmicId_t pmic_id)
	Select which extra PMIC rail subsequent mbltmlGetExtraPmic*() queries refer to.

Variables
int	mbltml.mbltml.MBLTML_DRIVER_VERSION_BUFFER_SIZE = 80
	Buffer size (bytes) guaranteed sufficient for mbltmlGetDriverVersion().
int	mbltml.mbltml.MBLTML_FIRMWARE_VERSION_BUFFER_SIZE = 80
	Buffer size (bytes) guaranteed sufficient for mbltmlGetFirmwareVersion().
int	mbltml.mbltml.MBLTML_NODE_NAME_BUFFER_SIZE = 80
	Buffer size (bytes) guaranteed sufficient for mbltmlGetNodeName().
	mbltml.mbltml.mbltmlDeviceType_t = c_uint
	Identifier of a Mobilint NPU device family.
int	mbltml.mbltml.MBLTML_DEVICE_ERROR = 0x0
	Invalid or uninitialized value.
int	mbltml.mbltml.MBLTML_DEVICE_ARIES = 0x1
	Aries / Aries2 family.
int	mbltml.mbltml.MBLTML_DEVICE_REGULUS = 0x2
	Regulus / Regulus2 (PCIe) family.
int	mbltml.mbltml.MBLTML_DEVICE_REGULUS_USB = 0x4
	Regulus / Regulus2 USB-attached family.
	mbltml.mbltml.mbltmlHardwareVersion_t = c_uint
	Specific hardware revision of a Mobilint NPU.
int	mbltml.mbltml.MBLTML_HARDWARE_VERSION_ARIES = 0x00000001
	Aries chip.
int	mbltml.mbltml.MBLTML_HARDWARE_VERSION_REGULUS = 0x00000002
	Regulus chip.
int	mbltml.mbltml.MBLTML_HARDWARE_VERSION_ARIES2 = 0x00000003
	Aries2 chip.
int	mbltml.mbltml.MBLTML_HARDWARE_VERSION_REGULUS2 = 0x00000004
	Regulus2 chip.
int	mbltml.mbltml.MBLTML_HARDWARE_VERSION_ERROR = 0x7FFFFFFF
	Invalid or uninitialized value.
	mbltml.mbltml.mbltmlStatusCode_t = c_uint
	Status code returned by mbltml C APIs.
int	mbltml.mbltml.MBLTML_SUCCESS = 0
	Operation completed successfully.
int	mbltml.mbltml.MBLTML_DRIVER_NOT_FOUND = 2
	Required driver could not be located.
int	mbltml.mbltml.MBLTML_INVALID_ARGUMENT = 3
	Invalid argument (NULL or out-of-range index).
int	mbltml.mbltml.MBLTML_UNINITIALIZED = 1
	API used before initialization.
int	mbltml.mbltml.MBLTML_NOT_SUPPORTED = 4
	Feature not supported on the target device.
int	mbltml.mbltml.MBLTML_INSUFFICIENT_LENGTH = 5
	Output buffer is too small.
	mbltml.mbltml.mbltmlExtraPmicId_t = c_uint
	Identifier of an extra PMIC rail.
int	mbltml.mbltml.MBLTML_EXTRA_PMIC_ID_NPU = 0
	NPU rail.
int	mbltml.mbltml.MBLTML_EXTRA_PMIC_ID_DDR = 1
	DDR rail.
int	mbltml.mbltml.MBLTML_EXTRA_PMIC_ID_PMIC = 2
	PMIC rail.
int	mbltml.mbltml.MBLTML_EXTRA_PMIC_ID_GOLDFINGER = 3
	Goldfinger rail.
	mbltml.mbltml.mbltmlCluster_t = c_uint
	NPU cluster identifier within a device.
int	mbltml.mbltml.MBLTML_CLUSTER_0 = 0x00010000
	Cluster 0.
int	mbltml.mbltml.MBLTML_CLUSTER_1 = 0x00020000
	Cluster 1.
int	mbltml.mbltml.MBLTML_CLUSTER_ERROR = 0x7FFF0000
	Represents an invalid or uninitialized state.
	mbltml.mbltml.mbltmlCore_t = c_uint
	NPU core identifier within a cluster.
int	mbltml.mbltml.MBLTML_CORE_0 = 1
	Local core 0.
int	mbltml.mbltml.MBLTML_CORE_1 = 2
	Local core 1.
int	mbltml.mbltml.MBLTML_CORE_2 = 3
	Local core 2.
int	mbltml.mbltml.MBLTML_CORE_3 = 4
	Local core 3.
int	mbltml.mbltml.MBLTML_CORE_GLOBAL = 0x0000FFFE
	Global (all cores aggregated).
int	mbltml.mbltml.MBLTML_CORE_ERROR = 0x0000FFFF
	Represents an invalid or uninitialized state.
	mbltml.mbltml._clib = None

Detailed Description

Python API provides Mobilint NPU monitoring and telemetry.

Function Documentation

◆ _loadLibrary()

None mbltml.mbltml._loadLibrary ( )

protected

Definition at line 177 of file mbltml.py.

◆ _mbltmlThrowError()

None mbltml.mbltml._mbltmlThrowError ( mbltmlStatusCode_t ret )

protected

Definition at line 363 of file mbltml.py.

◆ mbltmlInit()

None mbltml.mbltml.mbltmlInit ( )

Initialize the mbltml library for all supported device types.

Equivalent to calling mbltmlInitDevices() with every mbltmlDeviceType_t enabled. Must be called (directly or via mbltmlInitDevices()) before any other mbltml API.

Exceptions

MBLTMLError on failure.

Definition at line 369 of file mbltml.py.

◆ mbltmlInitDevices()

None mbltml.mbltml.mbltmlInitDevices ( Set[mbltmlDeviceType_t] device_types )

Initialize the mbltml library for a selected set of device types.

Parameters

device_types Set of mbltmlDeviceType_t values indicating which device families to enumerate and monitor.

Exceptions

MBLTMLError on failure.

Definition at line 383 of file mbltml.py.

◆ mbltmlShutdown()

None mbltml.mbltml.mbltmlShutdown ( )

Release all resources held by the mbltml library.

After this call, any further API usage requires re-initialization via mbltmlInit() or mbltmlInitDevices().

Exceptions

MBLTMLError on failure.

Definition at line 398 of file mbltml.py.

◆ mbltmlGetDeviceCount()

int mbltml.mbltml.mbltmlGetDeviceCount ( )

Get the total number of devices detected by the library.

Note: Supported on all device types.

Returns: The number of devices detected.

Exceptions

MBLTMLError on failure.

Definition at line 411 of file mbltml.py.

◆ mbltmlGetDriverVersion()

str mbltml.mbltml.mbltmlGetDriverVersion ( mbltmlDeviceType_t device_type )

Get the driver version string for a specific device family.

Note: Supported on all device types.

Parameters

device_type Device family whose driver version is queried.

Returns: The driver version string.

Exceptions

MBLTMLError on failure.

Definition at line 426 of file mbltml.py.

◆ mbltmlGetDriverRevision()

int mbltml.mbltml.mbltmlGetDriverRevision ( mbltmlDeviceType_t device_type )

Get the driver revision number for a specific device family.

Note: Supported on all device types.

Parameters

device_type Device family whose driver revision is queried.

Returns: The driver revision number.

Exceptions

MBLTMLError on failure.

Definition at line 444 of file mbltml.py.

◆ mbltmlGetNodeName()

str mbltml.mbltml.mbltmlGetNodeName ( int dev_no )

Get the node name of a device.

Note: Supported on all device types.

Parameters

dev_no Device index. Total device count is obtained via mbltmlGetDeviceCount().

Returns: The node name string.

Exceptions

MBLTMLInvalidArgumentError	if `dev_no` is out of range of the device count.
MBLTMLError	on other failures.

Definition at line 460 of file mbltml.py.

◆ mbltmlGetDeviceType()

mbltmlDeviceType_t mbltml.mbltml.mbltmlGetDeviceType ( int dev_no )

Get the device family type of a device.

Note: Supported on all device types.

Parameters

dev_no Device index. Total device count is obtained via mbltmlGetDeviceCount().

Returns: The mbltmlDeviceType_t of the device.

Exceptions

MBLTMLInvalidArgumentError	if `dev_no` is out of range of the device count.
MBLTMLError	on other failures.

Definition at line 477 of file mbltml.py.

◆ mbltmlGetHardwareVersion()

mbltmlHardwareVersion_t mbltml.mbltml.mbltmlGetHardwareVersion ( int dev_no )

Get the hardware version of a device.

Note: Supported on all device types.

Parameters

dev_no Device index. Total device count is obtained via mbltmlGetDeviceCount().

Returns: The mbltmlHardwareVersion_t of the device.

Exceptions

MBLTMLInvalidArgumentError	if `dev_no` is out of range of the device count.
MBLTMLError	on other failures.

Definition at line 494 of file mbltml.py.

◆ mbltmlGetFirmwareVersion()

str mbltml.mbltml.mbltmlGetFirmwareVersion ( int dev_no )

Get the firmware version string of a device.

Note: Supported on all device types.

Parameters

dev_no Device index. Total device count is obtained via mbltmlGetDeviceCount().

Returns: The firmware version string.

Exceptions

MBLTMLInvalidArgumentError	if `dev_no` is out of range of the device count.
MBLTMLError	on other failures.

Definition at line 511 of file mbltml.py.

◆ mbltmlGetFirmwareRevision()

int mbltml.mbltml.mbltmlGetFirmwareRevision ( int dev_no )

Get the firmware revision number of a device.

Note: Supported on all device types.

Parameters

dev_no Device index. Total device count is obtained via mbltmlGetDeviceCount().

Returns: The firmware revision.

Exceptions

MBLTMLInvalidArgumentError	if `dev_no` is out of range of the device count.
MBLTMLError	on other failures.

Definition at line 530 of file mbltml.py.

◆ mbltmlGetFirmwareCRC()

int mbltml.mbltml.mbltmlGetFirmwareCRC ( int dev_no )

Get the CRC of the currently-loaded firmware image.

Note: Supported on MBLTML_DEVICE_ARIES only.

Parameters

dev_no Device index. Total device count is obtained via mbltmlGetDeviceCount().

Returns: The firmware CRC.

Exceptions

MBLTMLInvalidArgumentError	if `dev_no` is out of range of the device count.
MBLTMLError	on other failures.

Definition at line 547 of file mbltml.py.

◆ mbltmlGetTemperature()

int mbltml.mbltml.mbltmlGetTemperature ( int dev_no )

Get the current die temperature of a device.

Note: Supported on all device types.

Parameters

dev_no Device index. Total device count is obtained via mbltmlGetDeviceCount().

Returns: The temperature reading.

Exceptions

MBLTMLInvalidArgumentError	if `dev_no` is out of range of the device count.
MBLTMLError	on other failures.

Definition at line 564 of file mbltml.py.

◆ mbltmlGetSignalType()

int mbltml.mbltml.mbltmlGetSignalType ( int dev_no )

Get the current signal-type indicator reported by the device.

Note: Supported on all device types.

Parameters

dev_no Device index. Total device count is obtained via mbltmlGetDeviceCount().

Returns: The signal-type value.

Exceptions

MBLTMLInvalidArgumentError	if `dev_no` is out of range of the device count.
MBLTMLError	on other failures.

Definition at line 581 of file mbltml.py.

◆ mbltmlGetNPUClock()

int mbltml.mbltml.mbltmlGetNPUClock ( int dev_no )

Get the current NPU clock frequency of a device.

Note: Supported on all device types.

Parameters

dev_no Device index. Total device count is obtained via mbltmlGetDeviceCount().

Returns: The NPU clock value.

Exceptions

MBLTMLInvalidArgumentError	if `dev_no` is out of range of the device count.
MBLTMLError	on other failures.

Definition at line 598 of file mbltml.py.

◆ mbltmlGetBusClock()

int mbltml.mbltml.mbltmlGetBusClock ( int dev_no )

Get the current bus clock frequency of a device.

Note: Supported on MBLTML_DEVICE_ARIES only.

Parameters

dev_no Device index. Total device count is obtained via mbltmlGetDeviceCount().

Returns: The bus clock value.

Exceptions

MBLTMLInvalidArgumentError	if `dev_no` is out of range of the device count.
MBLTMLError	on other failures.

Definition at line 615 of file mbltml.py.

◆ mbltmlGetFanDuty()

int mbltml.mbltml.mbltmlGetFanDuty ( int dev_no )

Get the current cooling-fan duty cycle of a device.

Note: Supported on MBLTML_DEVICE_ARIES only.

Parameters

dev_no Device index. Total device count is obtained via mbltmlGetDeviceCount().

Returns: The fan duty value.

Exceptions

MBLTMLInvalidArgumentError	if `dev_no` is out of range of the device count.
MBLTMLError	on other failures.

Definition at line 632 of file mbltml.py.

◆ mbltmlGetVendorId()

int mbltml.mbltml.mbltmlGetVendorId ( int dev_no )

Get the PCIe vendor ID of a device.

Note: Supported on MBLTML_DEVICE_ARIES only.

Parameters

dev_no Device index. Total device count is obtained via mbltmlGetDeviceCount().

Returns: The vendor ID.

Exceptions

MBLTMLInvalidArgumentError	if `dev_no` is out of range of the device count.
MBLTMLError	on other failures.

Definition at line 649 of file mbltml.py.

◆ mbltmlGetDeviceId()

int mbltml.mbltml.mbltmlGetDeviceId ( int dev_no )

Get the PCIe device ID of a device.

Note: Supported on MBLTML_DEVICE_ARIES only.

Parameters

dev_no Device index. Total device count is obtained via mbltmlGetDeviceCount().

Returns: The device ID.

Exceptions

MBLTMLInvalidArgumentError	if `dev_no` is out of range of the device count.
MBLTMLError	on other failures.

Definition at line 666 of file mbltml.py.

◆ mbltmlGetSubVendorId()

int mbltml.mbltml.mbltmlGetSubVendorId ( int dev_no )

Get the PCIe subsystem vendor ID of a device.

Note: Supported on MBLTML_DEVICE_ARIES only.

Parameters

dev_no Device index. Total device count is obtained via mbltmlGetDeviceCount().

Returns: The subsystem vendor ID.

Exceptions

MBLTMLInvalidArgumentError	if `dev_no` is out of range of the device count.
MBLTMLError	on other failures.

Definition at line 683 of file mbltml.py.

◆ mbltmlGetSubDeviceId()

int mbltml.mbltml.mbltmlGetSubDeviceId ( int dev_no )

Get the PCIe subsystem device ID of a device.

Note: Supported on MBLTML_DEVICE_ARIES only.

Parameters

dev_no Device index. Total device count is obtained via mbltmlGetDeviceCount().

Returns: The subsystem device ID.

Exceptions

MBLTMLInvalidArgumentError	if `dev_no` is out of range of the device count.
MBLTMLError	on other failures.

Definition at line 700 of file mbltml.py.

◆ mbltmlGetPcieGen()

int mbltml.mbltml.mbltmlGetPcieGen ( int dev_no )

Get the negotiated PCIe link generation of a device.

Note: Supported on MBLTML_DEVICE_ARIES only.

Parameters

dev_no Device index. Total device count is obtained via mbltmlGetDeviceCount().

Returns: The PCIe generation.

Exceptions

MBLTMLInvalidArgumentError	if `dev_no` is out of range of the device count.
MBLTMLError	on other failures.

Definition at line 717 of file mbltml.py.

◆ mbltmlGetPcieLanes()

int mbltml.mbltml.mbltmlGetPcieLanes ( int dev_no )

Get the negotiated PCIe link width (in lanes) of a device.

Note: Supported on MBLTML_DEVICE_ARIES only.

Parameters

dev_no Device index. Total device count is obtained via mbltmlGetDeviceCount().

Returns: The lane count.

Exceptions

MBLTMLInvalidArgumentError	if `dev_no` is out of range of the device count.
MBLTMLError	on other failures.

Definition at line 734 of file mbltml.py.

◆ mbltmlGetPcieRev()

int mbltml.mbltml.mbltmlGetPcieRev ( int dev_no )

Get the PCIe configuration-space revision ID of a device.

Note: Supported on MBLTML_DEVICE_ARIES only.

Parameters

dev_no Device index. Total device count is obtained via mbltmlGetDeviceCount().

Returns: The revision value.

Exceptions

MBLTMLInvalidArgumentError	if `dev_no` is out of range of the device count.
MBLTMLError	on other failures.

Definition at line 751 of file mbltml.py.

◆ mbltmlGetPcieClassCode()

int mbltml.mbltml.mbltmlGetPcieClassCode ( int dev_no )

Get the PCIe configuration-space class code of a device.

Note: Supported on MBLTML_DEVICE_ARIES only.

Parameters

dev_no Device index. Total device count is obtained via mbltmlGetDeviceCount().

Returns: The class code.

Exceptions

MBLTMLInvalidArgumentError	if `dev_no` is out of range of the device count.
MBLTMLError	on other failures.

Definition at line 768 of file mbltml.py.

◆ mbltmlGetTotalPower()

float mbltml.mbltml.mbltmlGetTotalPower ( int dev_no )

Get the total instantaneous power consumption of a device (W).

Note: Supported on MBLTML_DEVICE_ARIES only.

Parameters

dev_no Device index. Total device count is obtained via mbltmlGetDeviceCount().

Returns: The power reading.

Exceptions

MBLTMLInvalidArgumentError	if `dev_no` is out of range of the device count.
MBLTMLError	on other failures.

Definition at line 785 of file mbltml.py.

◆ mbltmlGetTotalCurrent()

float mbltml.mbltml.mbltmlGetTotalCurrent ( int dev_no )

Get the total instantaneous current draw of a device (A).

Note: Supported on MBLTML_DEVICE_ARIES only.

Parameters

dev_no Device index. Total device count is obtained via mbltmlGetDeviceCount().

Returns: The current reading.

Exceptions

MBLTMLInvalidArgumentError	if `dev_no` is out of range of the device count.
MBLTMLError	on other failures.

Definition at line 802 of file mbltml.py.

◆ mbltmlGetTotalVoltage()

float mbltml.mbltml.mbltmlGetTotalVoltage ( int dev_no )

Get the total instantaneous supply voltage of a device (V).

Note: Supported on MBLTML_DEVICE_ARIES only.

Parameters

dev_no Device index. Total device count is obtained via mbltmlGetDeviceCount().

Returns: The voltage reading.

Exceptions

MBLTMLInvalidArgumentError	if `dev_no` is out of range of the device count.
MBLTMLError	on other failures.

Definition at line 819 of file mbltml.py.

◆ mbltmlGetExtraPmicPower()

float mbltml.mbltml.mbltmlGetExtraPmicPower ( int dev_no )

Get the power consumption of the extra PMIC rail currently selected for the device (W).

Note: Supported on MBLTML_DEVICE_ARIES only.

The selected rail is controlled by mbltmlSetExtraPmicID() and can be queried via mbltmlGetExtraPmicId().

The firmware refreshes this reading once per second. After changing the selected rail with mbltmlSetExtraPmicID(), allow up to 1 second for the new rail's value to be reported.

Parameters

dev_no Device index. Total device count is obtained via mbltmlGetDeviceCount().

Returns: The power reading.

Exceptions

MBLTMLInvalidArgumentError	if `dev_no` is out of range of the device count.
MBLTMLError	on other failures.

Definition at line 836 of file mbltml.py.

◆ mbltmlGetExtraPmicCurrent()

float mbltml.mbltml.mbltmlGetExtraPmicCurrent ( int dev_no )

Get the current of the extra PMIC rail currently selected for the device (A).

Note: Supported on MBLTML_DEVICE_ARIES only.

The firmware refreshes this reading once per second. After changing the selected rail with mbltmlSetExtraPmicID(), allow up to 1 second for the new rail's value to be reported.

Parameters

dev_no Device index. Total device count is obtained via mbltmlGetDeviceCount().

Returns: The current reading.

Exceptions

MBLTMLInvalidArgumentError	if `dev_no` is out of range of the device count.
MBLTMLError	on other failures.

Definition at line 861 of file mbltml.py.

◆ mbltmlGetExtraPmicVoltage()

float mbltml.mbltml.mbltmlGetExtraPmicVoltage ( int dev_no )

Get the voltage of the extra PMIC rail currently selected for the device (V).

Note: Supported on MBLTML_DEVICE_ARIES only.

The firmware refreshes this reading once per second. After changing the selected rail with mbltmlSetExtraPmicID(), allow up to 1 second for the new rail's value to be reported.

Parameters

dev_no Device index. Total device count is obtained via mbltmlGetDeviceCount().

Returns: The voltage reading.

Exceptions

MBLTMLInvalidArgumentError	if `dev_no` is out of range of the device count.
MBLTMLError	on other failures.

Definition at line 883 of file mbltml.py.

◆ mbltmlGetExtraPmicId()

mbltmlExtraPmicId_t mbltml.mbltml.mbltmlGetExtraPmicId ( int dev_no )

Get the extra PMIC rail currently selected for the device.

Note: Supported on MBLTML_DEVICE_ARIES only.

Parameters

dev_no Device index. Total device count is obtained via mbltmlGetDeviceCount().

Returns: The selected mbltmlExtraPmicId_t value.

Exceptions

MBLTMLInvalidArgumentError	if `dev_no` is out of range of the device count.
MBLTMLError	on other failures.

Definition at line 905 of file mbltml.py.

◆ mbltmlGetTotalUtilization()

float mbltml.mbltml.mbltmlGetTotalUtilization ( int dev_no )

Get the overall NPU utilization of a device.

Note: Supported on all device types.

Parameters

dev_no Device index. Total device count is obtained via mbltmlGetDeviceCount().

Returns: The utilization value (typically a ratio in [0.0, 1.0] or a percentage).

Exceptions

MBLTMLInvalidArgumentError	if `dev_no` is out of range of the device count.
MBLTMLError	on other failures.

Definition at line 922 of file mbltml.py.

◆ mbltmlGetMemoryUsage()

int mbltml.mbltml.mbltmlGetMemoryUsage ( int dev_no )

Get the amount of device memory currently in use.

Note: Supported on all device types.

Parameters

dev_no Device index. Total device count is obtained via mbltmlGetDeviceCount().

Returns: The in-use memory in bytes.

Exceptions

MBLTMLInvalidArgumentError	if `dev_no` is out of range of the device count.
MBLTMLError	on other failures.

Definition at line 939 of file mbltml.py.

◆ mbltmlGetMemoryTotal()

int mbltml.mbltml.mbltmlGetMemoryTotal ( int dev_no )

Get the total amount of device memory available.

Note: Supported on all device types.

Parameters

dev_no Device index. Total device count is obtained via mbltmlGetDeviceCount().

Returns: The total memory in bytes.

Exceptions

MBLTMLInvalidArgumentError	if `dev_no` is out of range of the device count.
MBLTMLError	on other failures.

Definition at line 956 of file mbltml.py.

◆ mbltmlGetProcessInfos()

List[mbltmlProcessInfo_t] mbltml.mbltml.mbltmlGetProcessInfos ( int dev_no )

Get per-process usage information for a device.

Note: Supported on all device types.

Parameters

dev_no Device index. Total device count is obtained via mbltmlGetDeviceCount().

Returns: List of mbltmlProcessInfo_t records; empty if no process is running.

Exceptions

MBLTMLInvalidArgumentError	if `dev_no` is out of range of the device count.
MBLTMLError	on other failures.

Definition at line 973 of file mbltml.py.

◆ mbltmlGetCoreInfos()

List[mbltmlCoreInfo_t] mbltml.mbltml.mbltmlGetCoreInfos ( int dev_no )

Get per-core usage information for a device.

Note: Supported on all device types.

Parameters

dev_no Device index. Total device count is obtained via mbltmlGetDeviceCount().

Returns: List of mbltmlCoreInfo_t records.

Exceptions

MBLTMLInvalidArgumentError	if `dev_no` is out of range of the device count.
MBLTMLError	on other failures.

Definition at line 997 of file mbltml.py.

◆ mbltmlSetExtraPmicID()

None mbltml.mbltml.mbltmlSetExtraPmicID	(	int	dev_no,
		mbltmlExtraPmicId_t	pmic_id )

Select which extra PMIC rail subsequent mbltmlGetExtraPmic*() queries refer to.

Note: Supported on Aries2 hardware (MBLTML_HARDWARE_VERSION_ARIES2) only.

The underlying readings are refreshed by firmware once per second; allow up to 1 second after this call before mbltmlGetExtraPmicPower(), mbltmlGetExtraPmicCurrent() and mbltmlGetExtraPmicVoltage() reflect the newly selected rail.

Parameters

dev_no	Device index. Total device count is obtained via mbltmlGetDeviceCount().
pmic_id	Identifier of the extra PMIC rail to select.

Exceptions

MBLTMLInvalidArgumentError	if `dev_no` is out of range of the device count.
MBLTMLError	on other failures.

Definition at line 1021 of file mbltml.py.

Variable Documentation

◆ MBLTML_DRIVER_VERSION_BUFFER_SIZE

int mbltml.mbltml.MBLTML_DRIVER_VERSION_BUFFER_SIZE = 80

Buffer size (bytes) guaranteed sufficient for mbltmlGetDriverVersion().

Definition at line 17 of file mbltml.py.

◆ MBLTML_FIRMWARE_VERSION_BUFFER_SIZE

int mbltml.mbltml.MBLTML_FIRMWARE_VERSION_BUFFER_SIZE = 80

Buffer size (bytes) guaranteed sufficient for mbltmlGetFirmwareVersion().

Definition at line 19 of file mbltml.py.

◆ MBLTML_NODE_NAME_BUFFER_SIZE

int mbltml.mbltml.MBLTML_NODE_NAME_BUFFER_SIZE = 80

Buffer size (bytes) guaranteed sufficient for mbltmlGetNodeName().

Definition at line 21 of file mbltml.py.

◆ mbltmlDeviceType_t

mbltml.mbltml.mbltmlDeviceType_t = c_uint

Identifier of a Mobilint NPU device family.

Used to select a device family when calling family-scoped APIs such as mbltmlGetDriverVersion(), and to describe the family of an individual device returned by mbltmlGetDeviceType().

Definition at line 27 of file mbltml.py.

◆ MBLTML_DEVICE_ERROR

int mbltml.mbltml.MBLTML_DEVICE_ERROR = 0x0

Invalid or uninitialized value.

Definition at line 28 of file mbltml.py.

◆ MBLTML_DEVICE_ARIES

int mbltml.mbltml.MBLTML_DEVICE_ARIES = 0x1

Aries / Aries2 family.

Definition at line 29 of file mbltml.py.

◆ MBLTML_DEVICE_REGULUS

int mbltml.mbltml.MBLTML_DEVICE_REGULUS = 0x2

Regulus / Regulus2 (PCIe) family.

Definition at line 30 of file mbltml.py.

◆ MBLTML_DEVICE_REGULUS_USB

int mbltml.mbltml.MBLTML_DEVICE_REGULUS_USB = 0x4

Regulus / Regulus2 USB-attached family.

Definition at line 31 of file mbltml.py.

◆ mbltmlHardwareVersion_t

mbltml.mbltml.mbltmlHardwareVersion_t = c_uint

Specific hardware revision of a Mobilint NPU.

Definition at line 34 of file mbltml.py.

◆ MBLTML_HARDWARE_VERSION_ARIES

int mbltml.mbltml.MBLTML_HARDWARE_VERSION_ARIES = 0x00000001

Aries chip.

Definition at line 35 of file mbltml.py.

◆ MBLTML_HARDWARE_VERSION_REGULUS

int mbltml.mbltml.MBLTML_HARDWARE_VERSION_REGULUS = 0x00000002

Regulus chip.

Definition at line 36 of file mbltml.py.

◆ MBLTML_HARDWARE_VERSION_ARIES2

int mbltml.mbltml.MBLTML_HARDWARE_VERSION_ARIES2 = 0x00000003

Aries2 chip.

Definition at line 37 of file mbltml.py.

◆ MBLTML_HARDWARE_VERSION_REGULUS2

int mbltml.mbltml.MBLTML_HARDWARE_VERSION_REGULUS2 = 0x00000004

Regulus2 chip.

Definition at line 38 of file mbltml.py.

◆ MBLTML_HARDWARE_VERSION_ERROR

int mbltml.mbltml.MBLTML_HARDWARE_VERSION_ERROR = 0x7FFFFFFF

Invalid or uninitialized value.

Definition at line 39 of file mbltml.py.

◆ mbltmlStatusCode_t

mbltml.mbltml.mbltmlStatusCode_t = c_uint

Status code returned by mbltml C APIs.

In this Python binding, non-success codes are translated into MBLTMLError subclasses raised by the wrapper functions.

Definition at line 44 of file mbltml.py.

◆ MBLTML_SUCCESS

int mbltml.mbltml.MBLTML_SUCCESS = 0

Operation completed successfully.

Definition at line 45 of file mbltml.py.

◆ MBLTML_DRIVER_NOT_FOUND

int mbltml.mbltml.MBLTML_DRIVER_NOT_FOUND = 2

Required driver could not be located.

Definition at line 46 of file mbltml.py.

◆ MBLTML_INVALID_ARGUMENT

int mbltml.mbltml.MBLTML_INVALID_ARGUMENT = 3

Invalid argument (NULL or out-of-range index).

Definition at line 47 of file mbltml.py.

◆ MBLTML_UNINITIALIZED

int mbltml.mbltml.MBLTML_UNINITIALIZED = 1

API used before initialization.

Definition at line 48 of file mbltml.py.

◆ MBLTML_NOT_SUPPORTED

int mbltml.mbltml.MBLTML_NOT_SUPPORTED = 4

Feature not supported on the target device.

Definition at line 49 of file mbltml.py.

◆ MBLTML_INSUFFICIENT_LENGTH

int mbltml.mbltml.MBLTML_INSUFFICIENT_LENGTH = 5

Output buffer is too small.

Definition at line 50 of file mbltml.py.

◆ mbltmlExtraPmicId_t

mbltml.mbltml.mbltmlExtraPmicId_t = c_uint

Identifier of an extra PMIC rail.

Selects which auxiliary PMIC rail is reported by mbltmlGetExtraPmic*(). The active selection is changed with mbltmlSetExtraPmicID() and can be queried via mbltmlGetExtraPmicId().

Definition at line 56 of file mbltml.py.

◆ MBLTML_EXTRA_PMIC_ID_NPU

int mbltml.mbltml.MBLTML_EXTRA_PMIC_ID_NPU = 0

NPU rail.

Definition at line 57 of file mbltml.py.

◆ MBLTML_EXTRA_PMIC_ID_DDR

int mbltml.mbltml.MBLTML_EXTRA_PMIC_ID_DDR = 1

DDR rail.

Definition at line 58 of file mbltml.py.

◆ MBLTML_EXTRA_PMIC_ID_PMIC

int mbltml.mbltml.MBLTML_EXTRA_PMIC_ID_PMIC = 2

PMIC rail.

Definition at line 59 of file mbltml.py.

◆ MBLTML_EXTRA_PMIC_ID_GOLDFINGER

int mbltml.mbltml.MBLTML_EXTRA_PMIC_ID_GOLDFINGER = 3

Goldfinger rail.

Definition at line 60 of file mbltml.py.

◆ mbltmlCluster_t

mbltml.mbltml.mbltmlCluster_t = c_uint

NPU cluster identifier within a device.

Definition at line 63 of file mbltml.py.

◆ MBLTML_CLUSTER_0

int mbltml.mbltml.MBLTML_CLUSTER_0 = 0x00010000

Cluster 0.

Definition at line 64 of file mbltml.py.

◆ MBLTML_CLUSTER_1

int mbltml.mbltml.MBLTML_CLUSTER_1 = 0x00020000

Cluster 1.

Definition at line 65 of file mbltml.py.

◆ MBLTML_CLUSTER_ERROR

int mbltml.mbltml.MBLTML_CLUSTER_ERROR = 0x7FFF0000

Represents an invalid or uninitialized state.

Definition at line 66 of file mbltml.py.

◆ mbltmlCore_t

mbltml.mbltml.mbltmlCore_t = c_uint

NPU core identifier within a cluster.

Definition at line 69 of file mbltml.py.

◆ MBLTML_CORE_0

int mbltml.mbltml.MBLTML_CORE_0 = 1

Local core 0.

Definition at line 70 of file mbltml.py.

◆ MBLTML_CORE_1

int mbltml.mbltml.MBLTML_CORE_1 = 2

Local core 1.

Definition at line 71 of file mbltml.py.

◆ MBLTML_CORE_2

int mbltml.mbltml.MBLTML_CORE_2 = 3

Local core 2.

Definition at line 72 of file mbltml.py.

◆ MBLTML_CORE_3

int mbltml.mbltml.MBLTML_CORE_3 = 4

Local core 3.

Definition at line 73 of file mbltml.py.

◆ MBLTML_CORE_GLOBAL

int mbltml.mbltml.MBLTML_CORE_GLOBAL = 0x0000FFFE

Global (all cores aggregated).

Definition at line 74 of file mbltml.py.

◆ MBLTML_CORE_ERROR

int mbltml.mbltml.MBLTML_CORE_ERROR = 0x0000FFFF

Represents an invalid or uninitialized state.

Definition at line 75 of file mbltml.py.

◆ _clib

mbltml.mbltml._clib = None

protected

Definition at line 174 of file mbltml.py.

mbltml Python API

mbltml Python API#

Classes

Functions

Variables

Detailed Description

Function Documentation

◆ _loadLibrary()

◆ _mbltmlThrowError()

◆ mbltmlInit()

◆ mbltmlInitDevices()

◆ mbltmlShutdown()

◆ mbltmlGetDeviceCount()

◆ mbltmlGetDriverVersion()

◆ mbltmlGetDriverRevision()

◆ mbltmlGetNodeName()

◆ mbltmlGetDeviceType()

◆ mbltmlGetHardwareVersion()

◆ mbltmlGetFirmwareVersion()

◆ mbltmlGetFirmwareRevision()

◆ mbltmlGetFirmwareCRC()

◆ mbltmlGetTemperature()

◆ mbltmlGetSignalType()

◆ mbltmlGetNPUClock()

◆ mbltmlGetBusClock()

◆ mbltmlGetFanDuty()

◆ mbltmlGetVendorId()

◆ mbltmlGetDeviceId()

◆ mbltmlGetSubVendorId()

◆ mbltmlGetSubDeviceId()

◆ mbltmlGetPcieGen()

◆ mbltmlGetPcieLanes()

◆ mbltmlGetPcieRev()

◆ mbltmlGetPcieClassCode()

◆ mbltmlGetTotalPower()

◆ mbltmlGetTotalCurrent()

◆ mbltmlGetTotalVoltage()

◆ mbltmlGetExtraPmicPower()

◆ mbltmlGetExtraPmicCurrent()

◆ mbltmlGetExtraPmicVoltage()

◆ mbltmlGetExtraPmicId()

◆ mbltmlGetTotalUtilization()

◆ mbltmlGetMemoryUsage()

◆ mbltmlGetMemoryTotal()

◆ mbltmlGetProcessInfos()

◆ mbltmlGetCoreInfos()

◆ mbltmlSetExtraPmicID()

Variable Documentation

◆ MBLTML_DRIVER_VERSION_BUFFER_SIZE

◆ MBLTML_FIRMWARE_VERSION_BUFFER_SIZE

◆ MBLTML_NODE_NAME_BUFFER_SIZE

◆ mbltmlDeviceType_t

◆ MBLTML_DEVICE_ERROR

◆ MBLTML_DEVICE_ARIES

◆ MBLTML_DEVICE_REGULUS

◆ MBLTML_DEVICE_REGULUS_USB

◆ mbltmlHardwareVersion_t

◆ MBLTML_HARDWARE_VERSION_ARIES

◆ MBLTML_HARDWARE_VERSION_REGULUS

◆ MBLTML_HARDWARE_VERSION_ARIES2

◆ MBLTML_HARDWARE_VERSION_REGULUS2

◆ MBLTML_HARDWARE_VERSION_ERROR

◆ mbltmlStatusCode_t

◆ MBLTML_SUCCESS

◆ MBLTML_DRIVER_NOT_FOUND

◆ MBLTML_INVALID_ARGUMENT

◆ MBLTML_UNINITIALIZED

◆ MBLTML_NOT_SUPPORTED

◆ MBLTML_INSUFFICIENT_LENGTH

◆ mbltmlExtraPmicId_t

◆ MBLTML_EXTRA_PMIC_ID_NPU

◆ MBLTML_EXTRA_PMIC_ID_DDR

◆ MBLTML_EXTRA_PMIC_ID_PMIC

◆ MBLTML_EXTRA_PMIC_ID_GOLDFINGER

◆ mbltmlCluster_t

◆ MBLTML_CLUSTER_0

◆ MBLTML_CLUSTER_1

◆ MBLTML_CLUSTER_ERROR

◆ mbltmlCore_t

◆ MBLTML_CORE_0