mbltml Python API#
|
mbltml v1.4
mbltml — KR
|
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... | |
| 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 | |
Detailed Description
Python API provides Mobilint NPU monitoring and telemetry.
Function Documentation
◆ _loadLibrary()
◆ _mbltmlThrowError()
|
protected |
◆ mbltmlInit()
| None mbltml.mbltml.mbltmlInit | ( | ) |
◆ 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().
- Exceptions
-
MBLTMLError on failure.
◆ mbltmlGetDeviceCount()
| int mbltml.mbltml.mbltmlGetDeviceCount | ( | ) |
Get the total number of devices detected by the library.
- Note
- Supported on all driver types.
This returns the number of all detected devices regardless of their target device type, including devices whose target device type could not be identified.
- Attention
- Do not confuse this with mbltmlGetTargetDeviceCount(). Since unidentified devices are not addressable by any (target_device_type, dev_no) pair, this count may exceed the sum over every mbltmlTargetDeviceType_t.
- Returns
- The number of devices detected.
- Exceptions
-
MBLTMLError on failure.
◆ mbltmlGetTargetDeviceCount()
| int mbltml.mbltml.mbltmlGetTargetDeviceCount | ( | mbltmlTargetDeviceType_t | target_device_type | ) |
Get the number of detected devices of a specific target device type.
- Note
- Supported on all driver types.
- Parameters
-
target_device_type Target device type whose device count is queried.
- Returns
- The number of devices of
target_device_typedetected, or 0 if none is detected.
- Exceptions
-
MBLTMLError on failure.
◆ mbltmlGetDriverVersion()
| str mbltml.mbltml.mbltmlGetDriverVersion | ( | mbltmlDriverType_t | driver_type | ) |
◆ mbltmlGetDriverRevision()
| int mbltml.mbltml.mbltmlGetDriverRevision | ( | mbltmlDriverType_t | driver_type | ) |
◆ mbltmlGetNodeName()
| str mbltml.mbltml.mbltmlGetNodeName | ( | mbltmlTargetDeviceType_t | target_device_type, |
| int | dev_no ) |
Get the node name of a device.
- Note
- Supported on all driver types.
- Parameters
-
target_device_type Target device type of the device. dev_no Device index within target_device_type. Device count is obtained via mbltmlGetTargetDeviceCount().
- Returns
- The node name string.
- Exceptions
-
MBLTMLInvalidArgumentError if dev_nois out of range of thetarget_device_typedevice count.MBLTMLDeviceNotFoundError if no device of target_device_typeis detected.MBLTMLError on other failures.
◆ mbltmlGetDriverType()
| mbltmlDriverType_t mbltml.mbltml.mbltmlGetDriverType | ( | mbltmlTargetDeviceType_t | target_device_type, |
| int | dev_no ) |
Get the driver type of a device.
- Note
- Supported on all driver types.
- Parameters
-
target_device_type Target device type of the device. dev_no Device index within target_device_type. Device count is obtained via mbltmlGetTargetDeviceCount().
- Returns
- The mbltmlDriverType_t of the device.
- Exceptions
-
MBLTMLInvalidArgumentError if dev_nois out of range of thetarget_device_typedevice count.MBLTMLDeviceNotFoundError if no device of target_device_typeis detected.MBLTMLError on other failures.
◆ mbltmlGetOnDeviceDriverVersion()
| str mbltml.mbltml.mbltmlGetOnDeviceDriverVersion | ( | mbltmlTargetDeviceType_t | target_device_type, |
| int | dev_no ) |
Get the on-device driver version string of a device.
- Note
- Supported on MBLTML_DRIVER_REGULUS_USB only.
- Parameters
-
target_device_type Target device type of the device. dev_no Device index within target_device_type. Device count is obtained via mbltmlGetTargetDeviceCount().
- Returns
- The on-device driver version string.
- Exceptions
-
MBLTMLInvalidArgumentError if dev_nois out of range of thetarget_device_typedevice count.MBLTMLDeviceNotFoundError if no device of target_device_typeis detected.MBLTMLError on other failures.
◆ mbltmlGetOnDeviceDriverRevision()
| int mbltml.mbltml.mbltmlGetOnDeviceDriverRevision | ( | mbltmlTargetDeviceType_t | target_device_type, |
| int | dev_no ) |
Get the on-device driver revision number of a device.
- Note
- Supported on MBLTML_DRIVER_REGULUS_USB only.
- Parameters
-
target_device_type Target device type of the device. dev_no Device index within target_device_type. Device count is obtained via mbltmlGetTargetDeviceCount().
- Returns
- The on-device driver revision.
- Exceptions
-
MBLTMLInvalidArgumentError if dev_nois out of range of thetarget_device_typedevice count.MBLTMLDeviceNotFoundError if no device of target_device_typeis detected.MBLTMLError on other failures.
◆ mbltmlGetFirmwareVersion()
| str mbltml.mbltml.mbltmlGetFirmwareVersion | ( | mbltmlTargetDeviceType_t | target_device_type, |
| int | dev_no ) |
Get the firmware version string of a device.
- Note
- Supported on MBLTML_DRIVER_ARIES only.
- Parameters
-
target_device_type Target device type of the device. dev_no Device index within target_device_type. Device count is obtained via mbltmlGetTargetDeviceCount().
- Returns
- The firmware version string.
- Exceptions
-
MBLTMLInvalidArgumentError if dev_nois out of range of thetarget_device_typedevice count.MBLTMLDeviceNotFoundError if no device of target_device_typeis detected.MBLTMLError on other failures.
◆ mbltmlGetFirmwareRevision()
| int mbltml.mbltml.mbltmlGetFirmwareRevision | ( | mbltmlTargetDeviceType_t | target_device_type, |
| int | dev_no ) |
Get the firmware revision number of a device.
- Note
- Supported on MBLTML_DRIVER_ARIES only.
- Parameters
-
target_device_type Target device type of the device. dev_no Device index within target_device_type. Device count is obtained via mbltmlGetTargetDeviceCount().
- Returns
- The firmware revision.
- Exceptions
-
MBLTMLInvalidArgumentError if dev_nois out of range of thetarget_device_typedevice count.MBLTMLDeviceNotFoundError if no device of target_device_typeis detected.MBLTMLError on other failures.
◆ mbltmlGetFirmwareCRC()
| int mbltml.mbltml.mbltmlGetFirmwareCRC | ( | mbltmlTargetDeviceType_t | target_device_type, |
| int | dev_no ) |
Get the CRC of the currently-loaded firmware image.
- Note
- Supported on MBLTML_DRIVER_ARIES only.
- Parameters
-
target_device_type Target device type of the device. dev_no Device index within target_device_type. Device count is obtained via mbltmlGetTargetDeviceCount().
- Returns
- The firmware CRC.
- Exceptions
-
MBLTMLInvalidArgumentError if dev_nois out of range of thetarget_device_typedevice count.MBLTMLDeviceNotFoundError if no device of target_device_typeis detected.MBLTMLError on other failures.
◆ mbltmlGetTemperature()
| int mbltml.mbltml.mbltmlGetTemperature | ( | mbltmlTargetDeviceType_t | target_device_type, |
| int | dev_no ) |
Get the current die temperature of a device.
- Note
- Supported on all driver types.
- Parameters
-
target_device_type Target device type of the device. dev_no Device index within target_device_type. Device count is obtained via mbltmlGetTargetDeviceCount().
- Returns
- The temperature reading.
- Exceptions
-
MBLTMLInvalidArgumentError if dev_nois out of range of thetarget_device_typedevice count.MBLTMLDeviceNotFoundError if no device of target_device_typeis detected.MBLTMLError on other failures.
◆ mbltmlGetSignalType()
| int mbltml.mbltml.mbltmlGetSignalType | ( | mbltmlTargetDeviceType_t | target_device_type, |
| int | dev_no ) |
Get the current signal-type indicator reported by the device.
- Note
- Supported on all driver types.
- Parameters
-
target_device_type Target device type of the device. dev_no Device index within target_device_type. Device count is obtained via mbltmlGetTargetDeviceCount().
- Returns
- The signal-type value.
- Exceptions
-
MBLTMLInvalidArgumentError if dev_nois out of range of thetarget_device_typedevice count.MBLTMLDeviceNotFoundError if no device of target_device_typeis detected.MBLTMLError on other failures.
◆ mbltmlGetNPUClock()
| int mbltml.mbltml.mbltmlGetNPUClock | ( | mbltmlTargetDeviceType_t | target_device_type, |
| int | dev_no ) |
Get the current NPU clock frequency of a device.
- Note
- Supported on all driver types.
- Parameters
-
target_device_type Target device type of the device. dev_no Device index within target_device_type. Device count is obtained via mbltmlGetTargetDeviceCount().
- Returns
- The NPU clock value.
- Exceptions
-
MBLTMLInvalidArgumentError if dev_nois out of range of thetarget_device_typedevice count.MBLTMLDeviceNotFoundError if no device of target_device_typeis detected.MBLTMLError on other failures.
◆ mbltmlGetBusClock()
| int mbltml.mbltml.mbltmlGetBusClock | ( | mbltmlTargetDeviceType_t | target_device_type, |
| int | dev_no ) |
Get the current bus clock frequency of a device.
- Note
- Supported on MBLTML_DRIVER_ARIES only.
- Parameters
-
target_device_type Target device type of the device. dev_no Device index within target_device_type. Device count is obtained via mbltmlGetTargetDeviceCount().
- Returns
- The bus clock value.
- Exceptions
-
MBLTMLInvalidArgumentError if dev_nois out of range of thetarget_device_typedevice count.MBLTMLDeviceNotFoundError if no device of target_device_typeis detected.MBLTMLError on other failures.
◆ mbltmlGetFanDuty()
| int mbltml.mbltml.mbltmlGetFanDuty | ( | mbltmlTargetDeviceType_t | target_device_type, |
| int | dev_no ) |
Get the current cooling-fan duty cycle of a device.
- Note
- Supported on MBLTML_DRIVER_ARIES only.
- Parameters
-
target_device_type Target device type of the device. dev_no Device index within target_device_type. Device count is obtained via mbltmlGetTargetDeviceCount().
- Returns
- The fan duty value.
- Exceptions
-
MBLTMLInvalidArgumentError if dev_nois out of range of thetarget_device_typedevice count.MBLTMLDeviceNotFoundError if no device of target_device_typeis detected.MBLTMLError on other failures.
◆ mbltmlGetVendorId()
| int mbltml.mbltml.mbltmlGetVendorId | ( | mbltmlTargetDeviceType_t | target_device_type, |
| int | dev_no ) |
Get the PCIe vendor ID of a device.
- Note
- Supported on MBLTML_DRIVER_ARIES only.
- Parameters
-
target_device_type Target device type of the device. dev_no Device index within target_device_type. Device count is obtained via mbltmlGetTargetDeviceCount().
- Returns
- The vendor ID.
- Exceptions
-
MBLTMLInvalidArgumentError if dev_nois out of range of thetarget_device_typedevice count.MBLTMLDeviceNotFoundError if no device of target_device_typeis detected.MBLTMLError on other failures.
◆ mbltmlGetDeviceId()
| int mbltml.mbltml.mbltmlGetDeviceId | ( | mbltmlTargetDeviceType_t | target_device_type, |
| int | dev_no ) |
Get the PCIe device ID of a device.
- Note
- Supported on MBLTML_DRIVER_ARIES only.
- Parameters
-
target_device_type Target device type of the device. dev_no Device index within target_device_type. Device count is obtained via mbltmlGetTargetDeviceCount().
- Returns
- The device ID.
- Exceptions
-
MBLTMLInvalidArgumentError if dev_nois out of range of thetarget_device_typedevice count.MBLTMLDeviceNotFoundError if no device of target_device_typeis detected.MBLTMLError on other failures.
◆ mbltmlGetSubVendorId()
| int mbltml.mbltml.mbltmlGetSubVendorId | ( | mbltmlTargetDeviceType_t | target_device_type, |
| int | dev_no ) |
Get the PCIe subsystem vendor ID of a device.
- Note
- Supported on MBLTML_DRIVER_ARIES only.
- Parameters
-
target_device_type Target device type of the device. dev_no Device index within target_device_type. Device count is obtained via mbltmlGetTargetDeviceCount().
- Returns
- The subsystem vendor ID.
- Exceptions
-
MBLTMLInvalidArgumentError if dev_nois out of range of thetarget_device_typedevice count.MBLTMLDeviceNotFoundError if no device of target_device_typeis detected.MBLTMLError on other failures.
◆ mbltmlGetSubDeviceId()
| int mbltml.mbltml.mbltmlGetSubDeviceId | ( | mbltmlTargetDeviceType_t | target_device_type, |
| int | dev_no ) |
Get the PCIe subsystem device ID of a device.
- Note
- Supported on MBLTML_DRIVER_ARIES only.
- Parameters
-
target_device_type Target device type of the device. dev_no Device index within target_device_type. Device count is obtained via mbltmlGetTargetDeviceCount().
- Returns
- The subsystem device ID.
- Exceptions
-
MBLTMLInvalidArgumentError if dev_nois out of range of thetarget_device_typedevice count.MBLTMLDeviceNotFoundError if no device of target_device_typeis detected.MBLTMLError on other failures.
◆ mbltmlGetPcieGen()
| int mbltml.mbltml.mbltmlGetPcieGen | ( | mbltmlTargetDeviceType_t | target_device_type, |
| int | dev_no ) |
Get the negotiated PCIe link generation of a device.
- Note
- Supported on MBLTML_DRIVER_ARIES only.
- Parameters
-
target_device_type Target device type of the device. dev_no Device index within target_device_type. Device count is obtained via mbltmlGetTargetDeviceCount().
- Returns
- The PCIe generation.
- Exceptions
-
MBLTMLInvalidArgumentError if dev_nois out of range of thetarget_device_typedevice count.MBLTMLDeviceNotFoundError if no device of target_device_typeis detected.MBLTMLError on other failures.
◆ mbltmlGetPcieLanes()
| int mbltml.mbltml.mbltmlGetPcieLanes | ( | mbltmlTargetDeviceType_t | target_device_type, |
| int | dev_no ) |
Get the negotiated PCIe link width (in lanes) of a device.
- Note
- Supported on MBLTML_DRIVER_ARIES only.
- Parameters
-
target_device_type Target device type of the device. dev_no Device index within target_device_type. Device count is obtained via mbltmlGetTargetDeviceCount().
- Returns
- The lane count.
- Exceptions
-
MBLTMLInvalidArgumentError if dev_nois out of range of thetarget_device_typedevice count.MBLTMLDeviceNotFoundError if no device of target_device_typeis detected.MBLTMLError on other failures.
◆ mbltmlGetPcieRev()
| int mbltml.mbltml.mbltmlGetPcieRev | ( | mbltmlTargetDeviceType_t | target_device_type, |
| int | dev_no ) |
Get the PCIe configuration-space revision ID of a device.
- Note
- Supported on MBLTML_DRIVER_ARIES only.
- Parameters
-
target_device_type Target device type of the device. dev_no Device index within target_device_type. Device count is obtained via mbltmlGetTargetDeviceCount().
- Returns
- The revision value.
- Exceptions
-
MBLTMLInvalidArgumentError if dev_nois out of range of thetarget_device_typedevice count.MBLTMLDeviceNotFoundError if no device of target_device_typeis detected.MBLTMLError on other failures.
◆ mbltmlGetPcieClassCode()
| int mbltml.mbltml.mbltmlGetPcieClassCode | ( | mbltmlTargetDeviceType_t | target_device_type, |
| int | dev_no ) |
Get the PCIe configuration-space class code of a device.
- Note
- Supported on MBLTML_DRIVER_ARIES only.
- Parameters
-
target_device_type Target device type of the device. dev_no Device index within target_device_type. Device count is obtained via mbltmlGetTargetDeviceCount().
- Returns
- The class code.
- Exceptions
-
MBLTMLInvalidArgumentError if dev_nois out of range of thetarget_device_typedevice count.MBLTMLDeviceNotFoundError if no device of target_device_typeis detected.MBLTMLError on other failures.
◆ mbltmlGetTotalPower()
| float mbltml.mbltml.mbltmlGetTotalPower | ( | mbltmlTargetDeviceType_t | target_device_type, |
| int | dev_no ) |
Get the total instantaneous power consumption of a device (W).
- Note
- Supported on MBLTML_DRIVER_ARIES only.
- Parameters
-
target_device_type Target device type of the device. dev_no Device index within target_device_type. Device count is obtained via mbltmlGetTargetDeviceCount().
- Returns
- The power reading.
- Exceptions
-
MBLTMLInvalidArgumentError if dev_nois out of range of thetarget_device_typedevice count.MBLTMLDeviceNotFoundError if no device of target_device_typeis detected.MBLTMLError on other failures.
◆ mbltmlGetTotalCurrent()
| float mbltml.mbltml.mbltmlGetTotalCurrent | ( | mbltmlTargetDeviceType_t | target_device_type, |
| int | dev_no ) |
Get the total instantaneous current draw of a device (A).
- Note
- Supported on MBLTML_DRIVER_ARIES only.
- Parameters
-
target_device_type Target device type of the device. dev_no Device index within target_device_type. Device count is obtained via mbltmlGetTargetDeviceCount().
- Returns
- The current reading.
- Exceptions
-
MBLTMLInvalidArgumentError if dev_nois out of range of thetarget_device_typedevice count.MBLTMLDeviceNotFoundError if no device of target_device_typeis detected.MBLTMLError on other failures.
◆ mbltmlGetTotalVoltage()
| float mbltml.mbltml.mbltmlGetTotalVoltage | ( | mbltmlTargetDeviceType_t | target_device_type, |
| int | dev_no ) |
Get the total instantaneous supply voltage of a device (V).
- Note
- Supported on MBLTML_DRIVER_ARIES only.
- Parameters
-
target_device_type Target device type of the device. dev_no Device index within target_device_type. Device count is obtained via mbltmlGetTargetDeviceCount().
- Returns
- The voltage reading.
- Exceptions
-
MBLTMLInvalidArgumentError if dev_nois out of range of thetarget_device_typedevice count.MBLTMLDeviceNotFoundError if no device of target_device_typeis detected.MBLTMLError on other failures.
◆ mbltmlGetExtraPmicPower()
| 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).
- Note
- Supported on MBLTML_DRIVER_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
-
target_device_type Target device type of the device. dev_no Device index within target_device_type. Device count is obtained via mbltmlGetTargetDeviceCount().
- Returns
- The power reading.
- Exceptions
-
MBLTMLInvalidArgumentError if dev_nois out of range of thetarget_device_typedevice count.MBLTMLDeviceNotFoundError if no device of target_device_typeis detected.MBLTMLError on other failures.
◆ mbltmlGetExtraPmicCurrent()
| 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).
- Note
- Supported on MBLTML_DRIVER_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
-
target_device_type Target device type of the device. dev_no Device index within target_device_type. Device count is obtained via mbltmlGetTargetDeviceCount().
- Returns
- The current reading.
- Exceptions
-
MBLTMLInvalidArgumentError if dev_nois out of range of thetarget_device_typedevice count.MBLTMLDeviceNotFoundError if no device of target_device_typeis detected.MBLTMLError on other failures.
◆ mbltmlGetExtraPmicVoltage()
| 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).
- Note
- Supported on MBLTML_DRIVER_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
-
target_device_type Target device type of the device. dev_no Device index within target_device_type. Device count is obtained via mbltmlGetTargetDeviceCount().
- Returns
- The voltage reading.
- Exceptions
-
MBLTMLInvalidArgumentError if dev_nois out of range of thetarget_device_typedevice count.MBLTMLDeviceNotFoundError if no device of target_device_typeis detected.MBLTMLError on other failures.
◆ mbltmlGetExtraPmicId()
| mbltmlExtraPmicId_t mbltml.mbltml.mbltmlGetExtraPmicId | ( | mbltmlTargetDeviceType_t | target_device_type, |
| int | dev_no ) |
Get the extra PMIC rail currently selected for the device.
- Note
- Supported on MBLTML_DRIVER_ARIES only.
- Parameters
-
target_device_type Target device type of the device. dev_no Device index within target_device_type. Device count is obtained via mbltmlGetTargetDeviceCount().
- Returns
- The selected mbltmlExtraPmicId_t value.
- Exceptions
-
MBLTMLInvalidArgumentError if dev_nois out of range of thetarget_device_typedevice count.MBLTMLDeviceNotFoundError if no device of target_device_typeis detected.MBLTMLError on other failures.
◆ mbltmlGetTotalUtilization()
| float mbltml.mbltml.mbltmlGetTotalUtilization | ( | mbltmlTargetDeviceType_t | target_device_type, |
| int | dev_no ) |
Get the overall NPU utilization of a device.
- Note
- Supported on all driver types.
- Parameters
-
target_device_type Target device type of the device. dev_no Device index within target_device_type. Device count is obtained via mbltmlGetTargetDeviceCount().
- Returns
- The utilization value (typically a ratio in [0.0, 1.0] or a percentage).
- Exceptions
-
MBLTMLInvalidArgumentError if dev_nois out of range of thetarget_device_typedevice count.MBLTMLDeviceNotFoundError if no device of target_device_typeis detected.MBLTMLError on other failures.
◆ mbltmlGetMemoryUsage()
| int mbltml.mbltml.mbltmlGetMemoryUsage | ( | mbltmlTargetDeviceType_t | target_device_type, |
| int | dev_no ) |
Get the amount of device memory currently in use.
- Note
- Supported on all driver types.
- Parameters
-
target_device_type Target device type of the device. dev_no Device index within target_device_type. Device count is obtained via mbltmlGetTargetDeviceCount().
- Returns
- The in-use memory in bytes.
- Exceptions
-
MBLTMLInvalidArgumentError if dev_nois out of range of thetarget_device_typedevice count.MBLTMLDeviceNotFoundError if no device of target_device_typeis detected.MBLTMLError on other failures.
◆ mbltmlGetMemoryTotal()
| int mbltml.mbltml.mbltmlGetMemoryTotal | ( | mbltmlTargetDeviceType_t | target_device_type, |
| int | dev_no ) |
Get the total amount of device memory available.
- Note
- Supported on all driver types.
- Parameters
-
target_device_type Target device type of the device. dev_no Device index within target_device_type. Device count is obtained via mbltmlGetTargetDeviceCount().
- Returns
- The total memory in bytes.
- Exceptions
-
MBLTMLInvalidArgumentError if dev_nois out of range of thetarget_device_typedevice count.MBLTMLDeviceNotFoundError if no device of target_device_typeis detected.MBLTMLError on other failures.
◆ mbltmlGetProcessInfos()
| List[mbltmlProcessInfo_t] mbltml.mbltml.mbltmlGetProcessInfos | ( | mbltmlTargetDeviceType_t | target_device_type, |
| int | dev_no ) |
Get per-process usage information for a device.
- Note
- Supported on all driver types.
- Parameters
-
target_device_type Target device type of the device. dev_no Device index within target_device_type. Device count is obtained via mbltmlGetTargetDeviceCount().
- Returns
- List of mbltmlProcessInfo_t records; empty if no process is running.
- Exceptions
-
MBLTMLInvalidArgumentError if dev_nois out of range of thetarget_device_typedevice count.MBLTMLDeviceNotFoundError if no device of target_device_typeis detected.MBLTMLError on other failures.
◆ mbltmlGetCoreInfos()
| List[mbltmlCoreInfo_t] mbltml.mbltml.mbltmlGetCoreInfos | ( | mbltmlTargetDeviceType_t | target_device_type, |
| int | dev_no ) |
Get per-core usage information for a device.
- Note
- Supported on all driver types.
- Parameters
-
target_device_type Target device type of the device. dev_no Device index within target_device_type. Device count is obtained via mbltmlGetTargetDeviceCount().
- Returns
- List of mbltmlCoreInfo_t records.
- Exceptions
-
MBLTMLInvalidArgumentError if dev_nois out of range of thetarget_device_typedevice count.MBLTMLDeviceNotFoundError if no device of target_device_typeis detected.MBLTMLError on other failures.
◆ mbltmlSetExtraPmicID()
| 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.
- Note
- Supported on aries-rb device (MBLTML_TARGET_DEVICE_ARIES_RB) 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
-
target_device_type Target device type of the device. dev_no Device index within target_device_type. Device count is obtained via mbltmlGetTargetDeviceCount().pmic_id Identifier of the extra PMIC rail to select.
- Exceptions
-
MBLTMLInvalidArgumentError if dev_nois out of range of thetarget_device_typedevice count.MBLTMLDeviceNotFoundError if no device of target_device_typeis detected.MBLTMLError on other failures.
Variable Documentation
◆ MBLTML_DRIVER_VERSION_BUFFER_SIZE
| int mbltml.mbltml.MBLTML_DRIVER_VERSION_BUFFER_SIZE = 80 |
Buffer size (bytes) guaranteed sufficient for mbltmlGetDriverVersion().
◆ MBLTML_ON_DEVICE_DRIVER_VERSION_BUFFER_SIZE
| int mbltml.mbltml.MBLTML_ON_DEVICE_DRIVER_VERSION_BUFFER_SIZE = 80 |
Buffer size (bytes) guaranteed sufficient for mbltmlGetOnDeviceDriverVersion().
◆ MBLTML_FIRMWARE_VERSION_BUFFER_SIZE
| int mbltml.mbltml.MBLTML_FIRMWARE_VERSION_BUFFER_SIZE = 80 |
Buffer size (bytes) guaranteed sufficient for mbltmlGetFirmwareVersion().
◆ MBLTML_NODE_NAME_BUFFER_SIZE
| int mbltml.mbltml.MBLTML_NODE_NAME_BUFFER_SIZE = 80 |
Buffer size (bytes) guaranteed sufficient for mbltmlGetNodeName().
◆ mbltmlDriverType_t
| mbltml.mbltml.mbltmlDriverType_t = c_uint |
Identifier of a Mobilint NPU driver.
Used to select a driver when calling family-scoped APIs such as mbltmlGetDriverVersion(), and to describe the family of an individual device returned by mbltmlGetDriverType().
◆ MBLTML_DRIVER_ERROR
| int mbltml.mbltml.MBLTML_DRIVER_ERROR = 0x0 |
◆ MBLTML_DRIVER_ARIES
◆ MBLTML_DRIVER_REGULUS
| int mbltml.mbltml.MBLTML_DRIVER_REGULUS = 0x2 |
◆ MBLTML_DRIVER_REGULUS_USB
| int mbltml.mbltml.MBLTML_DRIVER_REGULUS_USB = 0x4 |
◆ mbltmlTargetDeviceType_t
| mbltml.mbltml.mbltmlTargetDeviceType_t = c_uint |
◆ MBLTML_TARGET_DEVICE_ARIES_RA
| int mbltml.mbltml.MBLTML_TARGET_DEVICE_ARIES_RA = 0x00000001 |
◆ MBLTML_TARGET_DEVICE_REGULUS_RA
| int mbltml.mbltml.MBLTML_TARGET_DEVICE_REGULUS_RA = 0x00000002 |
◆ MBLTML_TARGET_DEVICE_ARIES_RB
| int mbltml.mbltml.MBLTML_TARGET_DEVICE_ARIES_RB = 0x00000003 |
◆ MBLTML_TARGET_DEVICE_REGULUS_RB
| int mbltml.mbltml.MBLTML_TARGET_DEVICE_REGULUS_RB = 0x00000004 |
◆ MBLTML_TARGET_DEVICE_REGULUS_RA_USB
| int mbltml.mbltml.MBLTML_TARGET_DEVICE_REGULUS_RA_USB = 0x00000005 |
◆ MBLTML_TARGET_DEVICE_REGULUS_RB_USB
| int mbltml.mbltml.MBLTML_TARGET_DEVICE_REGULUS_RB_USB = 0x00000006 |
◆ MBLTML_TARGET_DEVICE_ERROR
| int mbltml.mbltml.MBLTML_TARGET_DEVICE_ERROR = 0x7FFFFFFF |
◆ mbltmlStatusCode_t
| mbltml.mbltml.mbltmlStatusCode_t = c_uint |
◆ MBLTML_SUCCESS
| int mbltml.mbltml.MBLTML_SUCCESS = 0 |
◆ MBLTML_DRIVER_NOT_FOUND
| int mbltml.mbltml.MBLTML_DRIVER_NOT_FOUND = 2 |
◆ MBLTML_INVALID_ARGUMENT
| int mbltml.mbltml.MBLTML_INVALID_ARGUMENT = 3 |
◆ MBLTML_UNINITIALIZED
| int mbltml.mbltml.MBLTML_UNINITIALIZED = 1 |
◆ MBLTML_NOT_SUPPORTED
| int mbltml.mbltml.MBLTML_NOT_SUPPORTED = 4 |
◆ MBLTML_INSUFFICIENT_LENGTH
| int mbltml.mbltml.MBLTML_INSUFFICIENT_LENGTH = 5 |
◆ MBLTML_DEVICE_NOT_FOUND
| int mbltml.mbltml.MBLTML_DEVICE_NOT_FOUND = 6 |
◆ 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().
◆ MBLTML_EXTRA_PMIC_ID_NPU
◆ MBLTML_EXTRA_PMIC_ID_DDR
◆ MBLTML_EXTRA_PMIC_ID_PMIC
◆ MBLTML_EXTRA_PMIC_ID_GOLDFINGER
| int mbltml.mbltml.MBLTML_EXTRA_PMIC_ID_GOLDFINGER = 3 |
◆ mbltmlCluster_t
| mbltml.mbltml.mbltmlCluster_t = c_uint |
◆ MBLTML_CLUSTER_0
◆ MBLTML_CLUSTER_1
◆ MBLTML_CLUSTER_ERROR
| int mbltml.mbltml.MBLTML_CLUSTER_ERROR = 0x7FFF0000 |
◆ mbltmlCore_t
| mbltml.mbltml.mbltmlCore_t = c_uint |
◆ MBLTML_CORE_0
◆ MBLTML_CORE_1
◆ MBLTML_CORE_2
◆ MBLTML_CORE_3
◆ MBLTML_CORE_GLOBAL
| int mbltml.mbltml.MBLTML_CORE_GLOBAL = 0x0000FFFE |
◆ MBLTML_CORE_ERROR
| int mbltml.mbltml.MBLTML_CORE_ERROR = 0x0000FFFF |
◆ _clib
Generated by