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
	mbltml.mbltml.code = other.code

Variable Documentation

◆ code

mbltml.mbltml.code = other.code

Definition at line 345 of file mbltml.py.

mbltml.py File Reference

mbltml.py File Reference#

Classes

Functions

Variables

Variable Documentation

◆ code