capi.h Source File

mbltml v1.4 mbltml — EN

• mbltml_src
• v1.4
• 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

25

26#ifdef __cplusplus

27extern "C" {

28#endif

29

30/* ------------------------------------------------------------------------- */

31/* Initialization / CleanUp APIs */

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

33

40MBLTML_EXPORT mbltmlStatusCode_t mbltmlInit();

41

51MBLTML_EXPORT mbltmlStatusCode_t mbltmlShutdown();

52

53/* ------------------------------------------------------------------------- */

54/* System-Wide Monitor APIs */

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

56

76MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetDeviceCount(unsigned int* counts);

77

91MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetTargetDeviceCount(mbltmlTargetDeviceType_t tdt,

92 unsigned int* counts);

93

112MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetDriverVersion(mbltmlDriverType_t dt,

113 char* version,

114 unsigned int length);

115

128MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetDriverRevision(mbltmlDriverType_t dt,

129 uint32_t* revision);

130

131/* ------------------------------------------------------------------------- */

132/* Device-Wise Monitor APIs */

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

134

158MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetNodeName(mbltmlTargetDeviceType_t tdt,

159 int dev_no, char* name,

160 unsigned int length);

161

179MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetDriverType(mbltmlTargetDeviceType_t tdt,

180 int dev_no,

181 mbltmlDriverType_t* driver_type);

182

206MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetOnDeviceDriverVersion(

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

208

226MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetOnDeviceDriverRevision(

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

228

252MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetFirmwareVersion(mbltmlTargetDeviceType_t tdt,

253 int dev_no, char* version,

254 unsigned int length);

255

273MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetFirmwareRevision(mbltmlTargetDeviceType_t tdt,

274 int dev_no,

275 uint32_t* revision);

276

294MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetFirmwareCRC(mbltmlTargetDeviceType_t tdt,

295 int dev_no, uint32_t* crc);

296

314MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetTemperature(mbltmlTargetDeviceType_t tdt,

315 int dev_no, int* temperature);

316

334MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetSignalType(mbltmlTargetDeviceType_t tdt,

335 int dev_no, uint32_t* signal_type);

336

354MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetNPUClock(mbltmlTargetDeviceType_t tdt,

355 int dev_no, uint32_t* clock);

356

374MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetBusClock(mbltmlTargetDeviceType_t tdt,

375 int dev_no, uint32_t* clock);

376

394MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetFanDuty(mbltmlTargetDeviceType_t tdt,

395 int dev_no, int* fan_duty);

396

414MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetVendorId(mbltmlTargetDeviceType_t tdt,

415 int dev_no, uint32_t* vendor_id);

416

434MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetDeviceId(mbltmlTargetDeviceType_t tdt,

435 int dev_no, uint32_t* device_id);

436

454MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetSubVendorId(mbltmlTargetDeviceType_t tdt,

455 int dev_no,

456 uint32_t* sub_vendor_id);

457

475MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetSubDeviceId(mbltmlTargetDeviceType_t tdt,

476 int dev_no,

477 uint32_t* sub_device_id);

478

496MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetPcieGen(mbltmlTargetDeviceType_t tdt,

497 int dev_no, uint32_t* pcie_gen);

498

516MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetPcieLanes(mbltmlTargetDeviceType_t tdt,

517 int dev_no, uint32_t* pcie_lanes);

518

536MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetPcieRev(mbltmlTargetDeviceType_t tdt,

537 int dev_no, uint32_t* pcie_rev);

538

556MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetPcieClassCode(mbltmlTargetDeviceType_t tdt,

557 int dev_no,

558 uint32_t* pcie_class_code);

559

577MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetTotalPower(mbltmlTargetDeviceType_t tdt,

578 int dev_no, double* power);

579

597MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetTotalCurrent(mbltmlTargetDeviceType_t tdt,

598 int dev_no, double* current);

599

617MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetTotalVoltage(mbltmlTargetDeviceType_t tdt,

618 int dev_no, double* voltage);

619

645MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetExtraPmicPower(mbltmlTargetDeviceType_t tdt,

646 int dev_no, double* power);

647

670MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetExtraPmicCurrent(mbltmlTargetDeviceType_t tdt,

671 int dev_no, double* current);

672

695MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetExtraPmicVoltage(mbltmlTargetDeviceType_t tdt,

696 int dev_no, double* voltage);

697

716MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetExtraPmicId(mbltmlTargetDeviceType_t tdt,

717 int dev_no,

718 mbltmlExtraPmicId_t* pmic_id);

719

738MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetTotalUtilization(mbltmlTargetDeviceType_t tdt,

739 int dev_no,

740 double* utilization);

741

759MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetMemoryUsage(mbltmlTargetDeviceType_t tdt,

760 int dev_no, int64_t* memory_usage);

761

779MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetMemoryTotal(mbltmlTargetDeviceType_t tdt,

780 int dev_no, int64_t* memory_total);

781

813MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetProcessInfos(mbltmlTargetDeviceType_t tdt,

814 int dev_no,

815 mbltmlProcessInfo_t* infos,

816 unsigned int* info_count);

817

844MBLTML_EXPORT mbltmlStatusCode_t mbltmlGetCoreInfos(mbltmlTargetDeviceType_t tdt,

845 int dev_no, mbltmlCoreInfo_t* infos,

846 unsigned int* info_count);

847

848/* ------------------------------------------------------------------------- */

849/* Device-Wise Control APIs */

850/* ------------------------------------------------------------------------- */

851

874MBLTML_EXPORT mbltmlStatusCode_t mbltmlSetExtraPmicID(mbltmlTargetDeviceType_t tdt,

875 int dev_no,

876 mbltmlExtraPmicId_t pmic_id);

877

878#ifdef __cplusplus

879}

880#endif

881

883

884#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.

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.

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.

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