capi.h File Reference

capi.h File Reference#

mbltml: capi.h File Reference
mbltml Test Preview
mbltml — EN
capi.h File Reference
#include "mbltml/export.h"
#include "mbltml/type.h"

Go to the source code of this file.

Macros

#define MBLTML_DRIVER_VERSION_BUFFER_SIZE   80
#define MBLTML_FIRMWARE_VERSION_BUFFER_SIZE   80
#define MBLTML_NODE_NAME_BUFFER_SIZE   80

Functions

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