capi.h Source File

mbltml v1.5 mbltml — EN

• mbltml_src
• v1.5
• include
• mbltml

capi.h

Go to the documentation of this file.

1// Copyright ⓒ 2019- Mobilint, Inc. All rights reserved.

5

6#ifndef MOBILINT_MBLTML_CAPI_H_

7#define MOBILINT_MBLTML_CAPI_H_

8

9#include "mbltml/export.h"

10#include "mbltml/type.h"

11

16

18#define MBLTML_DRIVER_VERSION_BUFFER_SIZE 80

20#define MBLTML_ON_DEVICE_DRIVER_VERSION_BUFFER_SIZE 80

22#define MBLTML_FIRMWARE_VERSION_BUFFER_SIZE 80

24#define MBLTML_NODE_NAME_BUFFER_SIZE 80

26#define MBLTML_PCIE_SLOT_BUFFER_SIZE 80

27

28#ifdef __cplusplus

29extern "C" {

30#endif

31

32/* ------------------------------------------------------------------------- */

33/* Initialization / CleanUp APIs */

34/* ------------------------------------------------------------------------- */

35

42MBLTML_EXPORT mbltmlStatusCode_t mbltmlInit();

43

53MBLTML_EXPORT mbltmlStatusCode_t mbltmlShutdown();

54

55/* ------------------------------------------------------------------------- */

56/* System-Wide Monitor APIs */

57/* ------------------------------------------------------------------------- */

58

78MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetDeviceCount(unsigned int* counts);

79

93MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetTargetDeviceCount(mbltmlTargetDeviceType_t tdt,

94 unsigned int* counts);

95

114MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetDriverVersion(mbltmlDriverType_t dt,

115 char* version,

116 unsigned int length);

117

130MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetDriverRevision(mbltmlDriverType_t dt,

131 uint32_t* revision);

132

133/* ------------------------------------------------------------------------- */

134/* Device-Wise Monitor APIs */

135/* ------------------------------------------------------------------------- */

136

160MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetNodeName(mbltmlTargetDeviceType_t tdt,

161 int dev_no, char* name,

162 unsigned int length);

163

181MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetDriverType(mbltmlTargetDeviceType_t tdt,

182 int dev_no,

183 mbltmlDriverType_t* driver_type);

184

208MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetOnDeviceDriverVersion(

209 mbltmlTargetDeviceType_t tdt, int dev_no, char* version, unsigned int length);

210

228MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetOnDeviceDriverRevision(

229 mbltmlTargetDeviceType_t tdt, int dev_no, uint32_t* revision);

230

254MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetFirmwareVersion(mbltmlTargetDeviceType_t tdt,

255 int dev_no, char* version,

256 unsigned int length);

257

275MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetFirmwareRevision(mbltmlTargetDeviceType_t tdt,

276 int dev_no,

277 uint32_t* revision);

278

296MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetFirmwareCRC(mbltmlTargetDeviceType_t tdt,

297 int dev_no, uint32_t* crc);

298

316MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetTemperature(mbltmlTargetDeviceType_t tdt,

317 int dev_no, int* temperature);

318

339MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetPcieSwitchTemperature(

340 mbltmlTargetDeviceType_t tdt, int dev_no, int* temperature);

341

360MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetChipId(mbltmlTargetDeviceType_t tdt, int dev_no,

361 int* chip_id);

362

380MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetSignalType(mbltmlTargetDeviceType_t tdt,

381 int dev_no, uint32_t* signal_type);

382

400MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetNPUClock(mbltmlTargetDeviceType_t tdt,

401 int dev_no, uint32_t* clock);

402

420MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetBusClock(mbltmlTargetDeviceType_t tdt,

421 int dev_no, uint32_t* clock);

422

440MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetFanDuty(mbltmlTargetDeviceType_t tdt,

441 int dev_no, int* fan_duty);

442

460MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetVendorId(mbltmlTargetDeviceType_t tdt,

461 int dev_no, uint32_t* vendor_id);

462

480MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetDeviceId(mbltmlTargetDeviceType_t tdt,

481 int dev_no, uint32_t* device_id);

482

500MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetSubVendorId(mbltmlTargetDeviceType_t tdt,

501 int dev_no,

502 uint32_t* sub_vendor_id);

503

521MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetSubDeviceId(mbltmlTargetDeviceType_t tdt,

522 int dev_no,

523 uint32_t* sub_device_id);

524

542MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetPcieGen(mbltmlTargetDeviceType_t tdt,

543 int dev_no, uint32_t* pcie_gen);

544

562MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetPcieLanes(mbltmlTargetDeviceType_t tdt,

563 int dev_no, uint32_t* pcie_lanes);

564

582MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetPcieRev(mbltmlTargetDeviceType_t tdt,

583 int dev_no, uint32_t* pcie_rev);

584

602MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetPcieClassCode(mbltmlTargetDeviceType_t tdt,

603 int dev_no,

604 uint32_t* pcie_class_code);

605

632MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetPcieSlot(mbltmlTargetDeviceType_t tdt,

633 int dev_no, char* pcie_slot,

634 unsigned int length);

635

653MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetTotalPower(mbltmlTargetDeviceType_t tdt,

654 int dev_no, double* power);

655

673MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetTotalCurrent(mbltmlTargetDeviceType_t tdt,

674 int dev_no, double* current);

675

693MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetTotalVoltage(mbltmlTargetDeviceType_t tdt,

694 int dev_no, double* voltage);

695

721MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetExtraPmicPower(mbltmlTargetDeviceType_t tdt,

722 int dev_no, double* power);

723

746MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetExtraPmicCurrent(mbltmlTargetDeviceType_t tdt,

747 int dev_no, double* current);

748

771MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetExtraPmicVoltage(mbltmlTargetDeviceType_t tdt,

772 int dev_no, double* voltage);

773

792MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetExtraPmicId(mbltmlTargetDeviceType_t tdt,

793 int dev_no,

794 mbltmlExtraPmicId_t* pmic_id);

795

814MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetTotalUtilization(mbltmlTargetDeviceType_t tdt,

815 int dev_no,

816 double* utilization);

817

835MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetMemoryUsage(mbltmlTargetDeviceType_t tdt,

836 int dev_no, int64_t* memory_usage);

837

855MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetMemoryTotal(mbltmlTargetDeviceType_t tdt,

856 int dev_no, int64_t* memory_total);

857

889MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetProcessInfos(mbltmlTargetDeviceType_t tdt,

890 int dev_no,

891 mbltmlProcessInfo_t* infos,

892 unsigned int* info_count);

893

920MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetCoreInfos(mbltmlTargetDeviceType_t tdt,

921 int dev_no, mbltmlCoreInfo_t* infos,

922 unsigned int* info_count);

923

924/* ------------------------------------------------------------------------- */

925/* Device-Wise Control APIs */

926/* ------------------------------------------------------------------------- */

927

950MBLTML_EXPORT mbltmlStatusCode_t mbltmlSetExtraPmicID(mbltmlTargetDeviceType_t tdt,

951 int dev_no,

952 mbltmlExtraPmicId_t pmic_id);

953

954#ifdef __cplusplus

955}

956#endif

957

959

960#endif // MOBILINT_MBLTML_CAPI_H_

mbltmlGetPcieClassCode

MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetPcieClassCode(mbltmlTargetDeviceType_t tdt, int dev_no, uint32_t *pcie_class_code)

Get the PCIe configuration-space class code of a device.

mbltmlGetSubVendorId

MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetSubVendorId(mbltmlTargetDeviceType_t tdt, int dev_no, uint32_t *sub_vendor_id)

Get the PCIe subsystem vendor ID of a device.

mbltmlGetBusClock

MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetBusClock(mbltmlTargetDeviceType_t tdt, int dev_no, uint32_t *clock)

Get the current bus clock frequency of a device.

mbltmlTargetDeviceType_t

mbltmlTargetDeviceType_t

Specific target device type of a Mobilint NPU.

Definition type.h:43

mbltmlGetSignalType

MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetSignalType(mbltmlTargetDeviceType_t tdt, int dev_no, uint32_t *signal_type)

Get the current signal-type indicator reported by the device.

mbltmlGetNodeName

MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetNodeName(mbltmlTargetDeviceType_t tdt, int dev_no, char *name, unsigned int length)

Get the node name of a device.

mbltmlGetDriverVersion

MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetDriverVersion(mbltmlDriverType_t dt, char *version, unsigned int length)

Get the driver version string for a specific driver.

mbltmlGetTotalUtilization

MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetTotalUtilization(mbltmlTargetDeviceType_t tdt, int dev_no, double *utilization)

Get the overall NPU utilization of a device.

mbltmlShutdown

MBLTML_EXPORT mbltmlStatusCode_t mbltmlShutdown()

Release all resources held by the mbltml library.

mbltmlGetPcieSlot

MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetPcieSlot(mbltmlTargetDeviceType_t tdt, int dev_no, char *pcie_slot, unsigned int length)

Get the PCIe slot location of a device.

mbltmlGetSubDeviceId

MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetSubDeviceId(mbltmlTargetDeviceType_t tdt, int dev_no, uint32_t *sub_device_id)

Get the PCIe subsystem device ID of a device.

mbltmlGetExtraPmicVoltage

MBLTML_EXPORT 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).

mbltmlInit

MBLTML_EXPORT mbltmlStatusCode_t mbltmlInit()

Initialize the mbltml library.

mbltmlSetExtraPmicID

MBLTML_EXPORT mbltmlStatusCode_t mbltmlSetExtraPmicID(mbltmlTargetDeviceType_t tdt, int dev_no, mbltmlExtraPmicId_t pmic_id)

Select which extra PMIC rail subsequent mbltmlGetExtraPmic*() queries refer to.

mbltmlGetTotalPower

MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetTotalPower(mbltmlTargetDeviceType_t tdt, int dev_no, double *power)

Get the total instantaneous power consumption of a device.

mbltmlGetDeviceCount

MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetDeviceCount(unsigned int *counts)

Get the total number of devices detected by the library.

mbltmlGetMemoryUsage

MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetMemoryUsage(mbltmlTargetDeviceType_t tdt, int dev_no, int64_t *memory_usage)

Get the amount of device memory currently in use.

mbltmlGetTargetDeviceCount

MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetTargetDeviceCount(mbltmlTargetDeviceType_t tdt, unsigned int *counts)

Get the number of detected devices of a specific target device type.

mbltmlGetPcieGen

MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetPcieGen(mbltmlTargetDeviceType_t tdt, int dev_no, uint32_t *pcie_gen)

Get the negotiated PCIe link generation of a device.

mbltmlGetExtraPmicCurrent

MBLTML_EXPORT 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).

mbltmlGetTotalCurrent

MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetTotalCurrent(mbltmlTargetDeviceType_t tdt, int dev_no, double *current)

Get the total instantaneous current draw of a device.

mbltmlGetOnDeviceDriverVersion

MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetOnDeviceDriverVersion(mbltmlTargetDeviceType_t tdt, int dev_no, char *version, unsigned int length)

Get the on-device driver version string of a device.

mbltmlGetTotalVoltage

MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetTotalVoltage(mbltmlTargetDeviceType_t tdt, int dev_no, double *voltage)

Get the total instantaneous supply voltage of a device.

mbltmlGetChipId

MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetChipId(mbltmlTargetDeviceType_t tdt, int dev_no, int *chip_id)

Get the chip ID of a device.

mbltmlGetExtraPmicPower

MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetExtraPmicPower(mbltmlTargetDeviceType_t tdt, int dev_no, double *power)

Get the power consumption of the extra PMIC rail currently selected for the device (W).

mbltmlDriverType_t

mbltmlDriverType_t

Identifier of a Mobilint NPU driver.

Definition type.h:33

mbltmlGetOnDeviceDriverRevision

MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetOnDeviceDriverRevision(mbltmlTargetDeviceType_t tdt, int dev_no, uint32_t *revision)

Get the on-device driver revision number of a device.

mbltmlGetPcieRev

MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetPcieRev(mbltmlTargetDeviceType_t tdt, int dev_no, uint32_t *pcie_rev)

Get the PCIe configuration-space revision ID of a device.

mbltmlStatusCode_t

mbltmlStatusCode_t

Status code returned by mbltml APIs.

Definition type.h:56

mbltmlGetCoreInfos

MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetCoreInfos(mbltmlTargetDeviceType_t tdt, int dev_no, mbltmlCoreInfo_t *infos, unsigned int *info_count)

Get per-core usage information for a device.

mbltmlGetFirmwareCRC

MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetFirmwareCRC(mbltmlTargetDeviceType_t tdt, int dev_no, uint32_t *crc)

Get the CRC of the currently-loaded firmware image.

mbltmlGetFanDuty

MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetFanDuty(mbltmlTargetDeviceType_t tdt, int dev_no, int *fan_duty)

Get the current cooling-fan duty cycle of a device.

mbltmlGetTemperature

MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetTemperature(mbltmlTargetDeviceType_t tdt, int dev_no, int *temperature)

Get the current die temperature of a device.

mbltmlGetVendorId

MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetVendorId(mbltmlTargetDeviceType_t tdt, int dev_no, uint32_t *vendor_id)

Get the PCIe vendor ID of a device.

mbltmlGetDriverRevision

MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetDriverRevision(mbltmlDriverType_t dt, uint32_t *revision)

Get the driver revision number for a specific driver.

mbltmlExtraPmicId_t

mbltmlExtraPmicId_t

Identifier of an extra PMIC rail.

Definition type.h:73

mbltmlGetDeviceId

MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetDeviceId(mbltmlTargetDeviceType_t tdt, int dev_no, uint32_t *device_id)

Get the PCIe device ID of a device.

mbltmlGetFirmwareVersion

MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetFirmwareVersion(mbltmlTargetDeviceType_t tdt, int dev_no, char *version, unsigned int length)

Get the firmware version string of a device.

mbltmlGetExtraPmicId

MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetExtraPmicId(mbltmlTargetDeviceType_t tdt, int dev_no, mbltmlExtraPmicId_t *pmic_id)

Get the extra PMIC rail currently selected for the device.

mbltmlGetPcieLanes

MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetPcieLanes(mbltmlTargetDeviceType_t tdt, int dev_no, uint32_t *pcie_lanes)

Get the negotiated PCIe link width (in lanes) of a device.

mbltmlGetProcessInfos

MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetProcessInfos(mbltmlTargetDeviceType_t tdt, int dev_no, mbltmlProcessInfo_t *infos, unsigned int *info_count)

Get per-process usage information for a device.

mbltmlGetNPUClock

MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetNPUClock(mbltmlTargetDeviceType_t tdt, int dev_no, uint32_t *clock)

Get the current NPU clock frequency of a device.

mbltmlGetDriverType

MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetDriverType(mbltmlTargetDeviceType_t tdt, int dev_no, mbltmlDriverType_t *driver_type)

Get the driver type of a device.

mbltmlGetMemoryTotal

MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetMemoryTotal(mbltmlTargetDeviceType_t tdt, int dev_no, int64_t *memory_total)

Get the total amount of device memory available.

mbltmlGetPcieSwitchTemperature

MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetPcieSwitchTemperature(mbltmlTargetDeviceType_t tdt, int dev_no, int *temperature)

Get the current temperature of the PCIe switch of a device.

mbltmlGetFirmwareRevision

MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetFirmwareRevision(mbltmlTargetDeviceType_t tdt, int dev_no, uint32_t *revision)

Get the firmware revision number of a device.

mbltmlCoreInfo_t

Per-core usage record returned by mbltmlGetCoreInfos().

Definition type.h:115

mbltmlProcessInfo_t

Per-process usage record returned by mbltmlGetProcessInfos().

Definition type.h:128

type.h

---

Generated by  1.14.0