C API¶
C API provides Mobilint NPU monitoring and telemetry.
This header is plain C (C99) so that mbltml/capi.h can be included from C translation units. Keep it free of C++-only constructs such as digit separators and default member initializers; test/test_capi.c guards this.
The structs below therefore carry no default member initializers. Every field is filled in by the API that returns them; a caller that declares one itself is responsible for initializing it (e.g. = {0}).
Data structures¶
| Name | Description |
|---|---|
mbltmlCoreId_t |
Composite identifier of an NPU core (cluster + core). |
mbltmlCoreInfo_t |
Per-core usage record returned by mbltmlGetCoreInfos(). |
mbltmlProcessInfo_t |
Per-process usage record returned by mbltmlGetProcessInfos(). |
Macros¶
MBLTML_DRIVER_VERSION_BUFFER_SIZE¶
Buffer size (bytes) guaranteed sufficient for mbltmlGetDriverVersion().
MBLTML_ON_DEVICE_DRIVER_VERSION_BUFFER_SIZE¶
Buffer size (bytes) guaranteed sufficient for mbltmlGetOnDeviceDriverVersion().
MBLTML_FIRMWARE_VERSION_BUFFER_SIZE¶
Buffer size (bytes) guaranteed sufficient for mbltmlGetFirmwareVersion().
MBLTML_NODE_NAME_BUFFER_SIZE¶
Buffer size (bytes) guaranteed sufficient for mbltmlGetNodeName().
Enumerations¶
mbltmlDriverType_t¶
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().
| Value | Description |
|---|---|
MBLTML_DRIVER_ERROR = 0x0 |
Invalid or uninitialized value. |
MBLTML_DRIVER_ARIES = 0x1 |
ARIES (PCIe) Driver. |
MBLTML_DRIVER_REGULUS = 0x2 |
REGULUS (SoC) Driver. |
MBLTML_DRIVER_REGULUS_USB = 0x4 |
REGULUS (USB) Driver. |
mbltmlTargetDeviceType_t¶
Specific target device type of a Mobilint NPU.
| Value | Description |
|---|---|
MBLTML_TARGET_DEVICE_ARIES_RA = 0x00000001 |
aries-ra. |
MBLTML_TARGET_DEVICE_REGULUS_RA = 0x00000002 |
regulus-ra. |
MBLTML_TARGET_DEVICE_ARIES_RB = 0x00000003 |
aries-rb. |
MBLTML_TARGET_DEVICE_REGULUS_RB = 0x00000004 |
regulus-rb. |
MBLTML_TARGET_DEVICE_REGULUS_RA_USB = 0x00000005 |
regulus-ra-usb. |
MBLTML_TARGET_DEVICE_REGULUS_RB_USB = 0x00000006 |
regulus-rb-usb. |
MBLTML_TARGET_DEVICE_ERROR = 0x7FFFFFFF |
Invalid or uninitialized. |
mbltmlStatusCode_t¶
Status code returned by mbltml APIs.
| Value | Description |
|---|---|
MBLTML_SUCCESS = 0 |
Operation completed successfully. |
MBLTML_UNINITIALIZED = 1 |
API used before initialization. |
MBLTML_DRIVER_NOT_FOUND = 2 |
Required driver could not be located. |
MBLTML_INVALID_ARGUMENT = 3 |
Invalid argument (NULL or out-of-range). |
MBLTML_NOT_SUPPORTED = 4 |
Feature not supported on target device. |
MBLTML_INSUFFICIENT_LENGTH = 5 |
Output buffer is too small. |
MBLTML_DEVICE_NOT_FOUND = 6 |
Requested target device could not be located. |
mbltmlExtraPmicId_t¶
Identifier of an extra PMIC rail.
Selects which auxiliary PMIC rail is reported by the mbltmlGetExtraPmic*() APIs. The active selection is changed with mbltmlSetExtraPmicID() and can be queried via mbltmlGetExtraPmicId().
| Value | Description |
|---|---|
MBLTML_EXTRA_PMIC_ID_NPU = 0 |
NPU rail. |
MBLTML_EXTRA_PMIC_ID_DDR = 1 |
DDR rail. |
MBLTML_EXTRA_PMIC_ID_PMIC = 2 |
PMIC rail. |
MBLTML_EXTRA_PMIC_ID_GOLDFINGER = 3 |
Goldfinger rail. |
mbltmlCluster_t¶
NPU cluster identifier within a device.
| Value | Description |
|---|---|
MBLTML_CLUSTER_0 = 1 << 16 |
Cluster 0. |
MBLTML_CLUSTER_1 = 2 << 16 |
Cluster 1. |
MBLTML_CLUSTER_ERROR = 0x7FFF0000 |
Invalid or uninitialized state. |
mbltmlCore_t¶
NPU core identifier within a cluster.
| Value | Description |
|---|---|
MBLTML_CORE_0 = 1 |
Local core 0. |
MBLTML_CORE_1 = 2 |
Local core 1. |
MBLTML_CORE_2 = 3 |
Local core 2. |
MBLTML_CORE_3 = 4 |
Local core 3. |
MBLTML_CORE_GLOBAL = 0x0000FFFE |
Global (all cores aggregated). |
MBLTML_CORE_ERROR = 0x0000FFFF |
Invalid or uninitialized state. |
Functions¶
mbltmlInit¶
Initialize the mbltml library.
Returns
MBLTML_SUCCESS on success, otherwise an appropriate mbltmlStatusCode_t error code.
mbltmlShutdown¶
Release all resources held by the mbltml library.
After this call, any further API usage requires re-initialization via mbltmlInit().
Returns
MBLTML_SUCCESS on success, otherwise an appropriate mbltmlStatusCode_t error code.
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 (tdt, dev_no) pair, this count may exceed the sum over every mbltmlTargetDeviceType_t.
Parameters
counts[out] — Pointer that receives the device count.
Returns
MBLTML_SUCCESS on success, MBLTML_INVALID_ARGUMENT if counts is NULL, or another mbltmlStatusCode_t error code on failure.
mbltmlGetTargetDeviceCount¶
Get the number of detected devices of a specific target device type.
Note
Supported on all driver types.
Parameters
tdt[in] — Target device type whose device count is queried.counts[out] — Pointer that receives the device count. Set to 0 if no device oftdtis detected.
Returns
MBLTML_SUCCESS on success, MBLTML_INVALID_ARGUMENT if counts is NULL, or another mbltmlStatusCode_t error code on failure.
mbltmlGetDriverVersion¶
mbltmlStatusCode_t mbltmlGetDriverVersion(mbltmlDriverType_t dt, char *version, unsigned int length)
Get the driver version string for a specific driver.
Note
Supported on all driver types.
A buffer of MBLTML_DRIVER_VERSION_BUFFER_SIZE bytes guarantees success. The resulting string is NUL-terminated. On failure, the contents of version are left unmodified.
Parameters
dt[in] — Driver type whose driver version is queried.version[out] — Output buffer that receives the version string.length[in] — Size, in bytes, ofversion.
Returns
MBLTML_SUCCESS on success, MBLTML_INVALID_ARGUMENT if version is NULL, MBLTML_INSUFFICIENT_LENGTH if length is too small, or another mbltmlStatusCode_t error code on failure.
mbltmlGetDriverRevision¶
Get the driver revision number for a specific driver.
Note
Supported on all driver types.
Parameters
dt[in] — Driver type whose driver revision is queried.revision[out] — Pointer that receives the revision number.
Returns
MBLTML_SUCCESS on success, MBLTML_INVALID_ARGUMENT if revision is NULL, or another mbltmlStatusCode_t error code on failure.
mbltmlGetNodeName¶
mbltmlStatusCode_t mbltmlGetNodeName(mbltmlTargetDeviceType_t tdt, int dev_no, char *name, unsigned int length)
Get the node name of a device.
Note
Supported on all driver types.
A buffer of MBLTML_NODE_NAME_BUFFER_SIZE bytes guarantees success. The resulting string is NUL-terminated. On failure, the contents of name are left unmodified.
Parameters
tdt[in] — Target device type of the device.dev_no[in] — Device index withintdt. See mbltmlGetTargetDeviceCount() for the count.name[out] — Output buffer that receives the node name.length[in] — Size, in bytes, ofname.
Returns
MBLTML_SUCCESS on success, MBLTML_INVALID_ARGUMENT if name is NULL, MBLTML_INVALID_ARGUMENT if dev_no is out of range of the tdt device count, MBLTML_DEVICE_NOT_FOUND if no device of tdt is detected, MBLTML_INSUFFICIENT_LENGTH if length is too small, or another mbltmlStatusCode_t error code on failure.
mbltmlGetDriverType¶
mbltmlStatusCode_t mbltmlGetDriverType(mbltmlTargetDeviceType_t tdt, int dev_no, mbltmlDriverType_t *driver_type)
Get the driver type of a device.
Note
Supported on all driver types.
Parameters
tdt[in] — Target device type of the device.dev_no[in] — Device index withintdt. See mbltmlGetTargetDeviceCount() for the count.driver_type[out] — Pointer that receives the mbltmlDriverType_t value.
Returns
MBLTML_SUCCESS on success, MBLTML_INVALID_ARGUMENT if driver_type is NULL, MBLTML_INVALID_ARGUMENT if dev_no is out of range of the tdt device count, MBLTML_DEVICE_NOT_FOUND if no device of tdt is detected, or another mbltmlStatusCode_t error code on failure.
mbltmlGetOnDeviceDriverVersion¶
mbltmlStatusCode_t mbltmlGetOnDeviceDriverVersion(mbltmlTargetDeviceType_t tdt, int dev_no, char *version, unsigned int length)
Get the on-device driver version string of a device.
Note
Supported on MBLTML_DRIVER_REGULUS_USB only.
A buffer of MBLTML_ON_DEVICE_DRIVER_VERSION_BUFFER_SIZE bytes guarantees success. The resulting string is NUL-terminated. On failure, the contents of version are left unmodified.
Parameters
tdt[in] — Target device type of the device.dev_no[in] — Device index withintdt. See mbltmlGetTargetDeviceCount() for the count.version[out] — Output buffer that receives the version string.length[in] — Size, in bytes, ofversion.
Returns
MBLTML_SUCCESS on success, MBLTML_INVALID_ARGUMENT if version is NULL, MBLTML_INVALID_ARGUMENT if dev_no is out of range of the tdt device count, MBLTML_DEVICE_NOT_FOUND if no device of tdt is detected, MBLTML_INSUFFICIENT_LENGTH if length is too small, or another mbltmlStatusCode_t error code on failure.
mbltmlGetOnDeviceDriverRevision¶
mbltmlStatusCode_t mbltmlGetOnDeviceDriverRevision(mbltmlTargetDeviceType_t tdt, int dev_no, uint32_t *revision)
Get the on-device driver revision number of a device.
Note
Supported on MBLTML_DRIVER_REGULUS_USB only.
Parameters
tdt[in] — Target device type of the device.dev_no[in] — Device index withintdt. See mbltmlGetTargetDeviceCount() for the count.revision[out] — Pointer that receives the on-device driver revision.
Returns
MBLTML_SUCCESS on success, MBLTML_INVALID_ARGUMENT if revision is NULL, MBLTML_INVALID_ARGUMENT if dev_no is out of range of the tdt device count, MBLTML_DEVICE_NOT_FOUND if no device of tdt is detected, or another mbltmlStatusCode_t error code on failure.
mbltmlGetFirmwareVersion¶
mbltmlStatusCode_t mbltmlGetFirmwareVersion(mbltmlTargetDeviceType_t tdt, int dev_no, char *version, unsigned int length)
Get the firmware version string of a device.
Note
Supported on MBLTML_DRIVER_ARIES only.
A buffer of MBLTML_FIRMWARE_VERSION_BUFFER_SIZE bytes guarantees success. The resulting string is NUL-terminated. On failure, the contents of version are left unmodified.
Parameters
tdt[in] — Target device type of the device.dev_no[in] — Device index withintdt. See mbltmlGetTargetDeviceCount() for the count.version[out] — Output buffer that receives the version string.length[in] — Size, in bytes, ofversion.
Returns
MBLTML_SUCCESS on success, MBLTML_INVALID_ARGUMENT if version is NULL, MBLTML_INVALID_ARGUMENT if dev_no is out of range of the tdt device count, MBLTML_DEVICE_NOT_FOUND if no device of tdt is detected, MBLTML_INSUFFICIENT_LENGTH if length is too small, or another mbltmlStatusCode_t error code on failure.
mbltmlGetFirmwareRevision¶
mbltmlStatusCode_t mbltmlGetFirmwareRevision(mbltmlTargetDeviceType_t tdt, int dev_no, uint32_t *revision)
Get the firmware revision number of a device.
Note
Supported on MBLTML_DRIVER_ARIES only.
Parameters
tdt[in] — Target device type of the device.dev_no[in] — Device index withintdt. See mbltmlGetTargetDeviceCount() for the count.revision[out] — Pointer that receives the firmware revision.
Returns
MBLTML_SUCCESS on success, MBLTML_INVALID_ARGUMENT if revision is NULL, MBLTML_INVALID_ARGUMENT if dev_no is out of range of the tdt device count, MBLTML_DEVICE_NOT_FOUND if no device of tdt is detected, or another mbltmlStatusCode_t error code on failure.
mbltmlGetFirmwareCRC¶
Get the CRC of the currently-loaded firmware image.
Note
Supported on MBLTML_DRIVER_ARIES only.
Parameters
tdt[in] — Target device type of the device.dev_no[in] — Device index withintdt. See mbltmlGetTargetDeviceCount() for the count.crc[out] — Pointer that receives the firmware CRC.
Returns
MBLTML_SUCCESS on success, MBLTML_INVALID_ARGUMENT if crc is NULL, MBLTML_INVALID_ARGUMENT if dev_no is out of range of the tdt device count, MBLTML_DEVICE_NOT_FOUND if no device of tdt is detected, or another mbltmlStatusCode_t error code on failure.
mbltmlGetTemperature¶
Get the current die temperature of a device.
Note
Supported on all driver types.
Parameters
tdt[in] — Target device type of the device.dev_no[in] — Device index withintdt. See mbltmlGetTargetDeviceCount() for the count.temperature[out] — Pointer that receives the temperature reading.
Returns
MBLTML_SUCCESS on success, MBLTML_INVALID_ARGUMENT if temperature is NULL, MBLTML_INVALID_ARGUMENT if dev_no is out of range of the tdt device count, MBLTML_DEVICE_NOT_FOUND if no device of tdt is detected, or another mbltmlStatusCode_t error code on failure.
mbltmlGetSignalType¶
mbltmlStatusCode_t mbltmlGetSignalType(mbltmlTargetDeviceType_t tdt, int dev_no, uint32_t *signal_type)
Get the current signal-type indicator reported by the device.
Note
Supported on all driver types.
Parameters
tdt[in] — Target device type of the device.dev_no[in] — Device index withintdt. See mbltmlGetTargetDeviceCount() for the count.signal_type[out] — Pointer that receives the signal-type value.
Returns
MBLTML_SUCCESS on success, MBLTML_INVALID_ARGUMENT if signal_type is NULL, MBLTML_INVALID_ARGUMENT if dev_no is out of range of the tdt device count, MBLTML_DEVICE_NOT_FOUND if no device of tdt is detected, or another mbltmlStatusCode_t error code on failure.
mbltmlGetNPUClock¶
Get the current NPU clock frequency of a device.
Note
Supported on all driver types.
Parameters
tdt[in] — Target device type of the device.dev_no[in] — Device index withintdt. See mbltmlGetTargetDeviceCount() for the count.clock[out] — Pointer that receives the NPU clock value.
Returns
MBLTML_SUCCESS on success, MBLTML_INVALID_ARGUMENT if clock is NULL, MBLTML_INVALID_ARGUMENT if dev_no is out of range of the tdt device count, MBLTML_DEVICE_NOT_FOUND if no device of tdt is detected, or another mbltmlStatusCode_t error code on failure.
mbltmlGetBusClock¶
Get the current bus clock frequency of a device.
Note
Supported on MBLTML_DRIVER_ARIES only.
Parameters
tdt[in] — Target device type of the device.dev_no[in] — Device index withintdt. See mbltmlGetTargetDeviceCount() for the count.clock[out] — Pointer that receives the bus clock value.
Returns
MBLTML_SUCCESS on success, MBLTML_INVALID_ARGUMENT if clock is NULL, MBLTML_INVALID_ARGUMENT if dev_no is out of range of the tdt device count, MBLTML_DEVICE_NOT_FOUND if no device of tdt is detected, or another mbltmlStatusCode_t error code on failure.
mbltmlGetFanDuty¶
Get the current cooling-fan duty cycle of a device.
Note
Supported on MBLTML_DRIVER_ARIES only.
Parameters
tdt[in] — Target device type of the device.dev_no[in] — Device index withintdt. See mbltmlGetTargetDeviceCount() for the count.fan_duty[out] — Pointer that receives the fan duty value.
Returns
MBLTML_SUCCESS on success, MBLTML_INVALID_ARGUMENT if fan_duty is NULL, MBLTML_INVALID_ARGUMENT if dev_no is out of range of the tdt device count, MBLTML_DEVICE_NOT_FOUND if no device of tdt is detected, or another mbltmlStatusCode_t error code on failure.
mbltmlGetVendorId¶
Get the PCIe vendor ID of a device.
Note
Supported on MBLTML_DRIVER_ARIES only.
Parameters
tdt[in] — Target device type of the device.dev_no[in] — Device index withintdt. See mbltmlGetTargetDeviceCount() for the count.vendor_id[out] — Pointer that receives the vendor ID.
Returns
MBLTML_SUCCESS on success, MBLTML_INVALID_ARGUMENT if vendor_id is NULL, MBLTML_INVALID_ARGUMENT if dev_no is out of range of the tdt device count, MBLTML_DEVICE_NOT_FOUND if no device of tdt is detected, or another mbltmlStatusCode_t error code on failure.
mbltmlGetDeviceId¶
Get the PCIe device ID of a device.
Note
Supported on MBLTML_DRIVER_ARIES only.
Parameters
tdt[in] — Target device type of the device.dev_no[in] — Device index withintdt. See mbltmlGetTargetDeviceCount() for the count.device_id[out] — Pointer that receives the device ID.
Returns
MBLTML_SUCCESS on success, MBLTML_INVALID_ARGUMENT if device_id is NULL, MBLTML_INVALID_ARGUMENT if dev_no is out of range of the tdt device count, MBLTML_DEVICE_NOT_FOUND if no device of tdt is detected, or another mbltmlStatusCode_t error code on failure.
mbltmlGetSubVendorId¶
mbltmlStatusCode_t mbltmlGetSubVendorId(mbltmlTargetDeviceType_t tdt, int dev_no, uint32_t *sub_vendor_id)
Get the PCIe subsystem vendor ID of a device.
Note
Supported on MBLTML_DRIVER_ARIES only.
Parameters
tdt[in] — Target device type of the device.dev_no[in] — Device index withintdt. See mbltmlGetTargetDeviceCount() for the count.sub_vendor_id[out] — Pointer that receives the subsystem vendor ID.
Returns
MBLTML_SUCCESS on success, MBLTML_INVALID_ARGUMENT if sub_vendor_id is NULL, MBLTML_INVALID_ARGUMENT if dev_no is out of range of the tdt device count, MBLTML_DEVICE_NOT_FOUND if no device of tdt is detected, or another mbltmlStatusCode_t error code on failure.
mbltmlGetSubDeviceId¶
mbltmlStatusCode_t mbltmlGetSubDeviceId(mbltmlTargetDeviceType_t tdt, int dev_no, uint32_t *sub_device_id)
Get the PCIe subsystem device ID of a device.
Note
Supported on MBLTML_DRIVER_ARIES only.
Parameters
tdt[in] — Target device type of the device.dev_no[in] — Device index withintdt. See mbltmlGetTargetDeviceCount() for the count.sub_device_id[out] — Pointer that receives the subsystem device ID.
Returns
MBLTML_SUCCESS on success, MBLTML_INVALID_ARGUMENT if sub_device_id is NULL, MBLTML_INVALID_ARGUMENT if dev_no is out of range of the tdt device count, MBLTML_DEVICE_NOT_FOUND if no device of tdt is detected, or another mbltmlStatusCode_t error code on failure.
mbltmlGetPcieGen¶
Get the negotiated PCIe link generation of a device.
Note
Supported on MBLTML_DRIVER_ARIES only.
Parameters
tdt[in] — Target device type of the device.dev_no[in] — Device index withintdt. See mbltmlGetTargetDeviceCount() for the count.pcie_gen[out] — Pointer that receives the PCIe generation.
Returns
MBLTML_SUCCESS on success, MBLTML_INVALID_ARGUMENT if pcie_gen is NULL, MBLTML_INVALID_ARGUMENT if dev_no is out of range of the tdt device count, MBLTML_DEVICE_NOT_FOUND if no device of tdt is detected, or another mbltmlStatusCode_t error code on failure.
mbltmlGetPcieLanes¶
mbltmlStatusCode_t mbltmlGetPcieLanes(mbltmlTargetDeviceType_t tdt, int dev_no, uint32_t *pcie_lanes)
Get the negotiated PCIe link width (in lanes) of a device.
Note
Supported on MBLTML_DRIVER_ARIES only.
Parameters
tdt[in] — Target device type of the device.dev_no[in] — Device index withintdt. See mbltmlGetTargetDeviceCount() for the count.pcie_lanes[out] — Pointer that receives the lane count.
Returns
MBLTML_SUCCESS on success, MBLTML_INVALID_ARGUMENT if pcie_lanes is NULL, MBLTML_INVALID_ARGUMENT if dev_no is out of range of the tdt device count, MBLTML_DEVICE_NOT_FOUND if no device of tdt is detected, or another mbltmlStatusCode_t error code on failure.
mbltmlGetPcieRev¶
Get the PCIe configuration-space revision ID of a device.
Note
Supported on MBLTML_DRIVER_ARIES only.
Parameters
tdt[in] — Target device type of the device.dev_no[in] — Device index withintdt. See mbltmlGetTargetDeviceCount() for the count.pcie_rev[out] — Pointer that receives the revision value.
Returns
MBLTML_SUCCESS on success, MBLTML_INVALID_ARGUMENT if pcie_rev is NULL, MBLTML_INVALID_ARGUMENT if dev_no is out of range of the tdt device count, MBLTML_DEVICE_NOT_FOUND if no device of tdt is detected, or another mbltmlStatusCode_t error code on failure.
mbltmlGetPcieClassCode¶
mbltmlStatusCode_t mbltmlGetPcieClassCode(mbltmlTargetDeviceType_t tdt, int dev_no, uint32_t *pcie_class_code)
Get the PCIe configuration-space class code of a device.
Note
Supported on MBLTML_DRIVER_ARIES only.
Parameters
tdt[in] — Target device type of the device.dev_no[in] — Device index withintdt. See mbltmlGetTargetDeviceCount() for the count.pcie_class_code[out] — Pointer that receives the class code.
Returns
MBLTML_SUCCESS on success, MBLTML_INVALID_ARGUMENT if pcie_class_code is NULL, MBLTML_INVALID_ARGUMENT if dev_no is out of range of the tdt device count, MBLTML_DEVICE_NOT_FOUND if no device of tdt is detected, or another mbltmlStatusCode_t error code on failure.
mbltmlGetTotalPower¶
Get the total instantaneous power consumption of a device.
Note
Supported on MBLTML_DRIVER_ARIES only.
Parameters
tdt[in] — Target device type of the device.dev_no[in] — Device index withintdt. See mbltmlGetTargetDeviceCount() for the count.power[out] — Pointer that receives the power reading.
Returns
MBLTML_SUCCESS on success, MBLTML_INVALID_ARGUMENT if power is NULL, MBLTML_INVALID_ARGUMENT if dev_no is out of range of the tdt device count, MBLTML_DEVICE_NOT_FOUND if no device of tdt is detected, or another mbltmlStatusCode_t error code on failure.
mbltmlGetTotalCurrent¶
Get the total instantaneous current draw of a device.
Note
Supported on MBLTML_DRIVER_ARIES only.
Parameters
tdt[in] — Target device type of the device.dev_no[in] — Device index withintdt. See mbltmlGetTargetDeviceCount() for the count.current[out] — Pointer that receives the current reading.
Returns
MBLTML_SUCCESS on success, MBLTML_INVALID_ARGUMENT if current is NULL, MBLTML_INVALID_ARGUMENT if dev_no is out of range of the tdt device count, MBLTML_DEVICE_NOT_FOUND if no device of tdt is detected, or another mbltmlStatusCode_t error code on failure.
mbltmlGetTotalVoltage¶
Get the total instantaneous supply voltage of a device.
Note
Supported on MBLTML_DRIVER_ARIES only.
Parameters
tdt[in] — Target device type of the device.dev_no[in] — Device index withintdt. See mbltmlGetTargetDeviceCount() for the count.voltage[out] — Pointer that receives the voltage reading.
Returns
MBLTML_SUCCESS on success, MBLTML_INVALID_ARGUMENT if voltage is NULL, MBLTML_INVALID_ARGUMENT if dev_no is out of range of the tdt device count, MBLTML_DEVICE_NOT_FOUND if no device of tdt is detected, or another mbltmlStatusCode_t error code on failure.
mbltmlGetExtraPmicPower¶
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
tdt[in] — Target device type of the device.dev_no[in] — Device index withintdt. See mbltmlGetTargetDeviceCount() for the count.power[out] — Pointer that receives the power reading.
Returns
MBLTML_SUCCESS on success, MBLTML_INVALID_ARGUMENT if power is NULL, MBLTML_INVALID_ARGUMENT if dev_no is out of range of the tdt device count, MBLTML_DEVICE_NOT_FOUND if no device of tdt is detected, or another mbltmlStatusCode_t error code on failure.
mbltmlGetExtraPmicCurrent¶
mbltmlStatusCode_t mbltmlGetExtraPmicCurrent(mbltmlTargetDeviceType_t tdt, int dev_no, double *current)
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
tdt[in] — Target device type of the device.dev_no[in] — Device index withintdt. See mbltmlGetTargetDeviceCount() for the count.current[out] — Pointer that receives the current reading.
Returns
MBLTML_SUCCESS on success, MBLTML_INVALID_ARGUMENT if current is NULL, MBLTML_INVALID_ARGUMENT if dev_no is out of range of the tdt device count, MBLTML_DEVICE_NOT_FOUND if no device of tdt is detected, or another mbltmlStatusCode_t error code on failure.
mbltmlGetExtraPmicVoltage¶
mbltmlStatusCode_t mbltmlGetExtraPmicVoltage(mbltmlTargetDeviceType_t tdt, int dev_no, double *voltage)
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
tdt[in] — Target device type of the device.dev_no[in] — Device index withintdt. See mbltmlGetTargetDeviceCount() for the count.voltage[out] — Pointer that receives the voltage reading.
Returns
MBLTML_SUCCESS on success, MBLTML_INVALID_ARGUMENT if voltage is NULL, MBLTML_INVALID_ARGUMENT if dev_no is out of range of the tdt device count, MBLTML_DEVICE_NOT_FOUND if no device of tdt is detected, or another mbltmlStatusCode_t error code on failure.
mbltmlGetExtraPmicId¶
mbltmlStatusCode_t mbltmlGetExtraPmicId(mbltmlTargetDeviceType_t tdt, int dev_no, mbltmlExtraPmicId_t *pmic_id)
Get the extra PMIC rail currently selected for the device.
Note
Supported on MBLTML_DRIVER_ARIES only.
Parameters
tdt[in] — Target device type of the device.dev_no[in] — Device index withintdt. See mbltmlGetTargetDeviceCount() for the count.pmic_id[out] — Pointer that receives the selected mbltmlExtraPmicId_t value.
Returns
MBLTML_SUCCESS on success, MBLTML_INVALID_ARGUMENT if pmic_id is NULL, MBLTML_INVALID_ARGUMENT if dev_no is out of range of the tdt device count, MBLTML_DEVICE_NOT_FOUND if no device of tdt is detected, or another mbltmlStatusCode_t error code on failure.
mbltmlGetTotalUtilization¶
mbltmlStatusCode_t mbltmlGetTotalUtilization(mbltmlTargetDeviceType_t tdt, int dev_no, double *utilization)
Get the overall NPU utilization of a device.
Note
Supported on all driver types.
Parameters
tdt[in] — Target device type of the device.dev_no[in] — Device index withintdt. See mbltmlGetTargetDeviceCount() for the count.utilization[out] — Pointer that receives the utilization value (typically a ratio in [0.0, 1.0] or a percentage).
Returns
MBLTML_SUCCESS on success, MBLTML_INVALID_ARGUMENT if utilization is NULL, MBLTML_INVALID_ARGUMENT if dev_no is out of range of the tdt device count, MBLTML_DEVICE_NOT_FOUND if no device of tdt is detected, or another mbltmlStatusCode_t error code on failure.
mbltmlGetMemoryUsage¶
mbltmlStatusCode_t mbltmlGetMemoryUsage(mbltmlTargetDeviceType_t tdt, int dev_no, int64_t *memory_usage)
Get the amount of device memory currently in use.
Note
Supported on all driver types.
Parameters
tdt[in] — Target device type of the device.dev_no[in] — Device index withintdt. See mbltmlGetTargetDeviceCount() for the count.memory_usage[out] — Pointer that receives the in-use memory, in bytes.
Returns
MBLTML_SUCCESS on success, MBLTML_INVALID_ARGUMENT if memory_usage is NULL, MBLTML_INVALID_ARGUMENT if dev_no is out of range of the tdt device count, MBLTML_DEVICE_NOT_FOUND if no device of tdt is detected, or another mbltmlStatusCode_t error code on failure.
mbltmlGetMemoryTotal¶
mbltmlStatusCode_t mbltmlGetMemoryTotal(mbltmlTargetDeviceType_t tdt, int dev_no, int64_t *memory_total)
Get the total amount of device memory available.
Note
Supported on all driver types.
Parameters
tdt[in] — Target device type of the device.dev_no[in] — Device index withintdt. See mbltmlGetTargetDeviceCount() for the count.memory_total[out] — Pointer that receives the total memory, in bytes.
Returns
MBLTML_SUCCESS on success, MBLTML_INVALID_ARGUMENT if memory_total is NULL, MBLTML_INVALID_ARGUMENT if dev_no is out of range of the tdt device count, MBLTML_DEVICE_NOT_FOUND if no device of tdt is detected, or another mbltmlStatusCode_t error code on failure.
mbltmlGetProcessInfos¶
mbltmlStatusCode_t mbltmlGetProcessInfos(mbltmlTargetDeviceType_t tdt, int dev_no, mbltmlProcessInfo_t *infos, unsigned int *info_count)
Get per-process usage information for a device.
Note
Supported on all driver types.
This call supports the standard two-step query pattern:
- Pass
*info_count==0(withinfoseitherNULLor unused) to learn the required entry count, which is written back toinfo_count. - Pass a buffer with
*info_countset to its capacity to retrieve up to that many entries; the actual entry count is written back toinfo_count.
Parameters
tdt[in] — Target device type of the device.dev_no[in] — Device index withintdt. See mbltmlGetTargetDeviceCount() for the count.infos[out] — Output array that receives the process records. May beNULLwhen*info_countis0.info_count[in,out] — On input, the capacity ofinfosin entries (or0to query the required size). On output, the number of entries written or required.
Returns
MBLTML_SUCCESS on success, MBLTML_INVALID_ARGUMENT if info_count is NULL, or if infos is NULL while *info_count is non-zero, MBLTML_INVALID_ARGUMENT if dev_no is out of range of the tdt device count, MBLTML_DEVICE_NOT_FOUND if no device of tdt is detected, MBLTML_INSUFFICIENT_LENGTH if infos is too small to hold all entries, or another mbltmlStatusCode_t error code on failure.
mbltmlGetCoreInfos¶
mbltmlStatusCode_t mbltmlGetCoreInfos(mbltmlTargetDeviceType_t tdt, int dev_no, mbltmlCoreInfo_t *infos, unsigned int *info_count)
Get per-core usage information for a device.
Note
Supported on all driver types.
The two-step query pattern documented in mbltmlGetProcessInfos() applies.
Parameters
tdt[in] — Target device type of the device.dev_no[in] — Device index withintdt. See mbltmlGetTargetDeviceCount() for the count.infos[out] — Output array that receives the core records. May beNULLwhen*info_countis0.info_count[in,out] — On input, the capacity ofinfosin entries (or0to query the required size). On output, the number of entries written or required.
Returns
MBLTML_SUCCESS on success, MBLTML_INVALID_ARGUMENT if info_count is NULL, or if infos is NULL while *info_count is non-zero, MBLTML_INVALID_ARGUMENT if dev_no is out of range of the tdt device count, MBLTML_DEVICE_NOT_FOUND if no device of tdt is detected, MBLTML_INSUFFICIENT_LENGTH if infos is too small to hold all entries, or another mbltmlStatusCode_t error code on failure.
mbltmlSetExtraPmicID¶
mbltmlStatusCode_t mbltmlSetExtraPmicID(mbltmlTargetDeviceType_t tdt, 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
tdt[in] — Target device type of the device.dev_no[in] — Device index withintdt. See mbltmlGetTargetDeviceCount() for the count.pmic_id[in] — Identifier of the extra PMIC rail to select.
Returns
MBLTML_SUCCESS on success, MBLTML_INVALID_ARGUMENT if dev_no is out of range of the tdt device count, MBLTML_DEVICE_NOT_FOUND if no device of tdt is detected, or another mbltmlStatusCode_t error code on failure.