mbltml.py File Reference#
|
mbltml v1.4
mbltml — EN
|
Go to the source code of this file.
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... | |
| class | mbltml.mbltml.MBLTMLDeviceNotFoundError |
| Raised when the requested device cannot be located. More... | |
Functions | |
| None | mbltml.mbltml._loadLibrary () |
| None | mbltml.mbltml._mbltmlThrowError (mbltmlStatusCode_t ret) |
| None | mbltml.mbltml.mbltmlInit () |
| Initialize the mbltml library. | |
| 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. | |
| int | mbltml.mbltml.mbltmlGetTargetDeviceCount (mbltmlTargetDeviceType_t target_device_type) |
| Get the number of detected devices of a specific target device type. | |
| str | mbltml.mbltml.mbltmlGetDriverVersion (mbltmlDriverType_t driver_type) |
| Get the driver version string for a specific driver. | |
| int | mbltml.mbltml.mbltmlGetDriverRevision (mbltmlDriverType_t driver_type) |
| Get the driver revision number for a specific driver. | |
| str | mbltml.mbltml.mbltmlGetNodeName (mbltmlTargetDeviceType_t target_device_type, int dev_no) |
| Get the node name of a device. | |
| mbltmlDriverType_t | mbltml.mbltml.mbltmlGetDriverType (mbltmlTargetDeviceType_t target_device_type, int dev_no) |
| Get the driver type of a device. | |
| str | mbltml.mbltml.mbltmlGetOnDeviceDriverVersion (mbltmlTargetDeviceType_t target_device_type, int dev_no) |
| Get the on-device driver version string of a device. | |
| int | mbltml.mbltml.mbltmlGetOnDeviceDriverRevision (mbltmlTargetDeviceType_t target_device_type, int dev_no) |
| Get the on-device driver revision number of a device. | |
| str | mbltml.mbltml.mbltmlGetFirmwareVersion (mbltmlTargetDeviceType_t target_device_type, int dev_no) |
| Get the firmware version string of a device. | |
| int | mbltml.mbltml.mbltmlGetFirmwareRevision (mbltmlTargetDeviceType_t target_device_type, int dev_no) |
| Get the firmware revision number of a device. | |
| int | mbltml.mbltml.mbltmlGetFirmwareCRC (mbltmlTargetDeviceType_t target_device_type, int dev_no) |
| Get the CRC of the currently-loaded firmware image. | |
| int | mbltml.mbltml.mbltmlGetTemperature (mbltmlTargetDeviceType_t target_device_type, int dev_no) |
| Get the current die temperature of a device. | |
| int | mbltml.mbltml.mbltmlGetSignalType (mbltmlTargetDeviceType_t target_device_type, int dev_no) |
| Get the current signal-type indicator reported by the device. | |
| int | mbltml.mbltml.mbltmlGetNPUClock (mbltmlTargetDeviceType_t target_device_type, int dev_no) |
| Get the current NPU clock frequency of a device. | |
| int | mbltml.mbltml.mbltmlGetBusClock (mbltmlTargetDeviceType_t target_device_type, int dev_no) |
| Get the current bus clock frequency of a device. | |
| int | mbltml.mbltml.mbltmlGetFanDuty (mbltmlTargetDeviceType_t target_device_type, int dev_no) |
| Get the current cooling-fan duty cycle of a device. | |
| int | mbltml.mbltml.mbltmlGetVendorId (mbltmlTargetDeviceType_t target_device_type, int dev_no) |
| Get the PCIe vendor ID of a device. | |
| int | mbltml.mbltml.mbltmlGetDeviceId (mbltmlTargetDeviceType_t target_device_type, int dev_no) |
| Get the PCIe device ID of a device. | |
| int | mbltml.mbltml.mbltmlGetSubVendorId (mbltmlTargetDeviceType_t target_device_type, int dev_no) |
| Get the PCIe subsystem vendor ID of a device. | |
| int | mbltml.mbltml.mbltmlGetSubDeviceId (mbltmlTargetDeviceType_t target_device_type, int dev_no) |
| Get the PCIe subsystem device ID of a device. | |
| int | mbltml.mbltml.mbltmlGetPcieGen (mbltmlTargetDeviceType_t target_device_type, int dev_no) |
| Get the negotiated PCIe link generation of a device. | |
| int | mbltml.mbltml.mbltmlGetPcieLanes (mbltmlTargetDeviceType_t target_device_type, int dev_no) |
| Get the negotiated PCIe link width (in lanes) of a device. | |
| int | mbltml.mbltml.mbltmlGetPcieRev (mbltmlTargetDeviceType_t target_device_type, int dev_no) |
| Get the PCIe configuration-space revision ID of a device. | |
| int | mbltml.mbltml.mbltmlGetPcieClassCode (mbltmlTargetDeviceType_t target_device_type, int dev_no) |
| Get the PCIe configuration-space class code of a device. | |
| float | mbltml.mbltml.mbltmlGetTotalPower (mbltmlTargetDeviceType_t target_device_type, int dev_no) |
| Get the total instantaneous power consumption of a device (W). | |
| float | mbltml.mbltml.mbltmlGetTotalCurrent (mbltmlTargetDeviceType_t target_device_type, int dev_no) |
| Get the total instantaneous current draw of a device (A). | |
| float | mbltml.mbltml.mbltmlGetTotalVoltage (mbltmlTargetDeviceType_t target_device_type, int dev_no) |
| Get the total instantaneous supply voltage of a device (V). | |
| float | mbltml.mbltml.mbltmlGetExtraPmicPower (mbltmlTargetDeviceType_t target_device_type, int dev_no) |
| Get the power consumption of the extra PMIC rail currently selected for the device (W). | |
| float | mbltml.mbltml.mbltmlGetExtraPmicCurrent (mbltmlTargetDeviceType_t target_device_type, int dev_no) |
| Get the current of the extra PMIC rail currently selected for the device (A). | |
| float | mbltml.mbltml.mbltmlGetExtraPmicVoltage (mbltmlTargetDeviceType_t target_device_type, int dev_no) |
| Get the voltage of the extra PMIC rail currently selected for the device (V). | |
| mbltmlExtraPmicId_t | mbltml.mbltml.mbltmlGetExtraPmicId (mbltmlTargetDeviceType_t target_device_type, int dev_no) |
| Get the extra PMIC rail currently selected for the device. | |
| float | mbltml.mbltml.mbltmlGetTotalUtilization (mbltmlTargetDeviceType_t target_device_type, int dev_no) |
| Get the overall NPU utilization of a device. | |
| int | mbltml.mbltml.mbltmlGetMemoryUsage (mbltmlTargetDeviceType_t target_device_type, int dev_no) |
| Get the amount of device memory currently in use. | |
| int | mbltml.mbltml.mbltmlGetMemoryTotal (mbltmlTargetDeviceType_t target_device_type, int dev_no) |
| Get the total amount of device memory available. | |
| List[mbltmlProcessInfo_t] | mbltml.mbltml.mbltmlGetProcessInfos (mbltmlTargetDeviceType_t target_device_type, int dev_no) |
| Get per-process usage information for a device. | |
| List[mbltmlCoreInfo_t] | mbltml.mbltml.mbltmlGetCoreInfos (mbltmlTargetDeviceType_t target_device_type, int dev_no) |
| Get per-core usage information for a device. | |
| None | mbltml.mbltml.mbltmlSetExtraPmicID (mbltmlTargetDeviceType_t target_device_type, 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_ON_DEVICE_DRIVER_VERSION_BUFFER_SIZE = 80 |
| Buffer size (bytes) guaranteed sufficient for mbltmlGetOnDeviceDriverVersion(). | |
| 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.mbltmlDriverType_t = c_uint | |
| Identifier of a Mobilint NPU driver. | |
| int | mbltml.mbltml.MBLTML_DRIVER_ERROR = 0x0 |
| Invalid or uninitialized value. | |
| int | mbltml.mbltml.MBLTML_DRIVER_ARIES = 0x1 |
| ARIES Driver. | |
| int | mbltml.mbltml.MBLTML_DRIVER_REGULUS = 0x2 |
| REGULUS (SoC) Driver. | |
| int | mbltml.mbltml.MBLTML_DRIVER_REGULUS_USB = 0x4 |
| REGULUS (USB) Driver. | |
| mbltml.mbltml.mbltmlTargetDeviceType_t = c_uint | |
| Specific target device type of a Mobilint NPU. | |
| int | mbltml.mbltml.MBLTML_TARGET_DEVICE_ARIES_RA = 0x00000001 |
| aries-ra. | |
| int | mbltml.mbltml.MBLTML_TARGET_DEVICE_REGULUS_RA = 0x00000002 |
| regulus-ra. | |
| int | mbltml.mbltml.MBLTML_TARGET_DEVICE_ARIES_RB = 0x00000003 |
| aries-rb. | |
| int | mbltml.mbltml.MBLTML_TARGET_DEVICE_REGULUS_RB = 0x00000004 |
| regulus-rb. | |
| int | mbltml.mbltml.MBLTML_TARGET_DEVICE_REGULUS_RA_USB = 0x00000005 |
| regulus-ra-usb. | |
| int | mbltml.mbltml.MBLTML_TARGET_DEVICE_REGULUS_RB_USB = 0x00000006 |
| regulus-rb-usb. | |
| int | mbltml.mbltml.MBLTML_TARGET_DEVICE_ERROR = 0x7FFFFFFF |
| Invalid or uninitialized. | |
| 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. | |
| int | mbltml.mbltml.MBLTML_DEVICE_NOT_FOUND = 6 |
| Requested device could not be located. | |
| 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
Generated by
1.14.0