api.h File Reference

api.h File Reference#

mbltml: api.h File Reference
mbltml Test Preview
mbltml — EN
api.h File Reference
#include <string>
#include <unordered_set>
#include <vector>
#include "mbltml/export.h"
#include "mbltml/type.h"

Go to the source code of this file.

Functions

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