1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
|
#pragma once
// DISCLAIMER:
// THIS FILE IS CREATED FROM SCRATCH, BY READING THE OFFICIAL MTML API
// DOCUMENTATION REFERENCED BELOW, IN ORDER TO MAKE FASTFETCH MIT COMPLIANT.
#define MTML_DEVICE_PCI_SBDF_BUFFER_SIZE 32
#define MTML_DEVICE_NAME_BUFFER_SIZE 32
/**
* Return values for MTML API calls.
*/
typedef enum {
MTML_SUCCESS = 0,
} MtmlReturn;
/**
* The brand of the device.
*/
typedef enum {
MTML_BRAND_MTT = 0, //!< MTT series.
} MtmlBrandType;
typedef struct MtmlLibrary MtmlLibrary;
typedef struct MtmlSystem MtmlSystem;
typedef struct MtmlDevice MtmlDevice;
typedef struct MtmlGpu MtmlGpu;
typedef struct MtmlMemory MtmlMemory;
/**
* PCI information about a device.
*/
typedef struct
{
char sbdf[MTML_DEVICE_PCI_SBDF_BUFFER_SIZE]; //!< The tuple segment:bus:device.function PCI identifier (& NULL terminator).
unsigned int segment; //!< The PCI segment group(domain) on which the device's bus resides, 0 to 0xffffffff.
unsigned int bus; //!< The bus on which the device resides, 0 to 0xff.
unsigned int device; //!< The device ID on the bus, 0 to 31.
unsigned int pciDeviceId; //!< The combined 16-bit device ID and 16-bit vendor ID.
unsigned int pciSubsystemId; //!< The 32-bit sub system device ID.
unsigned int busWidth; //!< @deprecated This value set to zero.
float pciMaxSpeed; //!< The maximum link speed (transfer rate per lane) of the device. The unit is GT/s.
float pciCurSpeed; //!< The current link speed (transfer rate per lane) of the device. The unit is GT/s.
unsigned int pciMaxWidth; //!< The maximum link width of the device.
unsigned int pciCurWidth; //!< The current link width of the device.
unsigned int pciMaxGen; //!< The maximum supported generation of the device.
unsigned int pciCurGen; //!< The current generation of the device.
int rsvd[6]; //!< Reserved for future extension.
} MtmlPciInfo;
// Retrieves the number of cores of a device.
MtmlReturn mtmlDeviceCountGpuCores(const MtmlDevice* device, unsigned int* numCores);
// Retrieves the brand of a device.
MtmlReturn mtmlDeviceGetBrand(const MtmlDevice* dev, MtmlBrandType* type);
// Retrieves the index associated with the specified device.
MtmlReturn mtmlDeviceGetIndex(const MtmlDevice* dev, unsigned int* index);
// Retrieves the name of a device.
MtmlReturn mtmlDeviceGetName(const MtmlDevice* dev, char* name, unsigned int length);
// Retrieves the PCI attributes of a device.
MtmlReturn mtmlDeviceGetPciInfo(const MtmlDevice* dev, MtmlPciInfo* pci);
/**
* Retrieves the UUID of a specified device. The UUID is a hexadecimal string in the
* form of xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx, where each 'x' is an ASCII character that represents a hexadecimal
* digit. The UUID is globally unique for every single device thus can be used to identify different devices
* physically.
*/
MtmlReturn mtmlDeviceGetUUID(const MtmlDevice* dev, char* uuid, unsigned int length);
// Initializes a GPU opaque object to represent a specific graphic core on the target device that is designated by its index.
MtmlReturn mtmlDeviceInitGpu(const MtmlDevice* dev, MtmlGpu** gpu);
// Initializes a memory opaque object to represent the memory on the target device.
MtmlReturn mtmlDeviceInitMemory(const MtmlDevice* dev, MtmlMemory** mem);
// Retrieves the maximum supported clock speed for the device's graphic core.
MtmlReturn mtmlGpuGetMaxClock(const MtmlGpu* gpu, unsigned int* clockMhz);
// Retrieves the current temperature readings for the device's graphic core, in degrees Celsius.
MtmlReturn mtmlGpuGetTemperature(const MtmlGpu* gpu, unsigned int* temp);
// Retrieves the current utilization rate for the device's graphic core.
MtmlReturn mtmlGpuGetUtilization(const MtmlGpu* gpu, unsigned int* utilization);
// Retrieves the number of devices that can be accessed by the library opaque object.
MtmlReturn mtmlLibraryCountDevice(const MtmlLibrary* lib, unsigned int* count);
/**
* Initializes a device opaque object to represent a device that is designated by its index.
* The index ranges from (0) to (deviceCount - 1), where deviceCount is retrieved from \ref mtmlLibraryCountDevice().
*/
MtmlReturn mtmlLibraryInit(MtmlLibrary** lib);
/**
* Initializes a device opaque object to represent a device that is designated by its index.
* The index ranges from (0) to (deviceCount - 1), where deviceCount is retrieved from \ref mtmlLibraryCountDevice().
*/
MtmlReturn mtmlLibraryInitDeviceByIndex(const MtmlLibrary* lib, unsigned int index, MtmlDevice** dev);
/**
* Initializes a device opaque object to represent a device that is designated by its PCI Sbdf.
* The PCI Sbdf format like 00000000:3a:00.0 refer to \ref MtmlPciInfo::sbdf.
*/
MtmlReturn mtmlLibraryInitDeviceByPciSbdf(const MtmlLibrary* lib, const char* pciSbdf, MtmlDevice** dev);
// Initializes a MtmlSystem opaque pointer that is bound to a library opaque object.
MtmlReturn mtmlLibraryInitSystem(const MtmlLibrary* lib, MtmlSystem** sys);
/**
* Shuts down the library opaque object that is previously initialized by \ref mtmlLibraryInit() and releases its resources.
* The \a lib pointer cannot be used anymore after this function returns.
*/
MtmlReturn mtmlLibraryShutDown(MtmlLibrary* lib);
// Retrieves the amount of total memory available on the device, in bytes.
MtmlReturn mtmlMemoryGetTotal(const MtmlMemory* mem, unsigned long long* total);
// Retrieves the amount of used memory on the device, in bytes.
MtmlReturn mtmlMemoryGetUsed(const MtmlMemory* mem, unsigned long long* used);
// Retrieves the current memory utilization rate for the device.
MtmlReturn mtmlMemoryGetUtilization(const MtmlMemory* mem, unsigned int* utilization);
|
