HWMonitor SDK Programmer's Guide. Version May 2015

Transcription

1 HWMonitor SDK Programmer's Guide Version May 2015 Copyright Datapath Ltd Page - 1

2 Contents HWMonitor SDK Programmer's Guide... 1 Contents... 2 Document Revision History... 4 Overview... 5 SDK Contents... 6 HWMonitor Function Reference... 7 HWMLoad... 7 HWMFree... 8 HWMGetPlatformType... 9 HWMGetChassisCount HWMOpenChassis HWMCloseChassis HWMIsChassisParameterSupported HWMGetChassisParameterMinimum HWMGetChassisParameterMaximum HWMGetChassisParameter HWMRegisterChassisStatusCB HWMGetCPUCount HWMOpenCPU HWMCloseCPU HWMIsCPUParameterSupported HWMGetCPUParameterMinimum HWMGetCPUParameterMaximum HWMGetCPUParameter HWMRegisterCPUStatusCB HWMGetGPUCount HWMGetNumberGPUPerCard HWMGetGPUCardType HWMOpenGPU Copyright Datapath Ltd Page - 2

3 HWMCloseGPU HWMIsGPUParameterSupported HWMGetGPUParameterMinimum HWMGetGPUParameterMaximum HWMGetGPUParameter HWMRegisterGPUStatusCB HWMGetVisionCount HWMGetVisionParameter HWMGetVisionName HWMGetLogicalDeviceLocation HWMGetSQXCount HWMGetSQXParameter HWMGetSQXName HWMonitor Enums, Structures and Callback Functions CHASSIS_PARAM CPU_PARAM GPU_PARAM VISION_PARAM SUPPORTED_PLATFORM GPU_CARD_TYPE CHASSIS_DESCRIPTOR CPU_DESCRIPTOR GPU_DESCRIPTOR HWMCHASSISSTATUS HWMCPUSTATUS HWMGPUSTATUS Copyright Datapath Ltd Page - 3

4 Document Revision History Revision Date Changes First release Added functions for monitoring Vision capture cards: HWMGetVisionCount HWMGetVisionParameter HWMGetVisionName Added function to locate a device: HWMGetLogicalDeviceLocation Copyright Datapath Ltd Page - 4

5 Overview HWMonitor is an application interface for the sensor data from Datapath Wall Controller Systems and Datapath graphics cards. HWMonitor is implemented within HWMonitor.dll, a dynamic link library which is part of the Datapath DriverInstall package. HWMonitor supports ImageDP4 and Image4 graphics cards, Vision capture cards and VSN Wall Controller Systems utilizing Datapath PCI express backplanes. Copyright Datapath Ltd Page - 5

6 SDK Contents Support for the HWMonitor is included within the drivers for Datapath Image4 graphics cards. The HWMonitor SDK is implemented in C and has the following structure. INCLUDE\HWMAPI.H This file defines all the functions available within HWMonitor. INCLUDE\HWM.H This file defines the structures and constants used within HWMonitor. INCLUDE\HWMERROR.H This file defines error codes that can be returned by the capture card device driver. DOCS\HWMonitor SDK Programmer Guide.pdf This document. Most applications will use the import library, HWMonitor.LIB, to automatically load HWMonitor on start-up. For those applications that wish to control when HWMonitor is loaded, two additional files are provided. INCLUDE\API.H This file defines functions to help with loading of HWMonitor and obtaining pointers to the functions. INCLUDE\API.C This file implements functions to help with loading of HWMonitor and obtaining pointers to functions. SAMPLE Directories These directories contain sample Visual Studio applications demonstrating how to use HWMonitor. Copyright Datapath Ltd Page - 6

7 HWMonitor Function Reference This section documents the functions available within HWMonitor HWMLoad HWMLoad ( PHHWMDLL phhwmdll ) This function loads the HWMonitor interface. It creates a handle for the HWMonitor interface which must be used when closing the interface. HWMLoad must be the first HWMonitor function called by an application. A return value of HWMERROR_NO_ERROR indicates that one or more compatible graphics cards or Wall Controller Systems have been found, configured and are ready to be used. This function will fail when there is no supported hardware or when the driver is not correctly installed. phhwmdll A pointer to the HHWMDLL variable that receives the handle to the HWMonitor interface. Copyright Datapath Ltd Page - 7

8 HWMFree HWMFree ( HHWMDLL hhwmdll ) This function closes the HWMonitor interface and releases all resources claimed by the interface. HWMFree must be the last HWMonitor function called by an application. HWMFree must not be called if HWMLoad failed. hhwmdll The handle created by HWMLoad. Copyright Datapath Ltd Page - 8

9 HWMGetPlatformType HWMGetPlatformType ( SUPPORTED_PLATFORM *pplatformtype ) This function retrieves the type of Single Board Computer (SBC) on the system. pplatformtype Pointer to a variable which will hold a value of type SUPPORTED_PLATFORM. For more details see SUPPORTED_PLATFORM in this document. Copyright Datapath Ltd Page - 9

10 HWMGetChassisCount HWMGetChassisCount ( *pchassiscount ) This function retrieves the number of Datapath VSN chassis in the system. pchassiscount Pointer to a variable which will hold the number of chassis. Copyright Datapath Ltd Page - 10

11 HWMOpenChassis HWMOpenChassis ( PCHASSIS_DESCRIPTOR popendescriptor, HANDLE *phchassis ) This function opens a chassis, creates the necessary resources and creates a handler for the chassis so this handler can be used by other functions to query property values. popendescriptor This parameter refers to a structure of type CHASSIS_DESCRIPTOR which is used to identify the chassis to be opened. For more details see CHASSIS_DESCRIPTOR in this document. The size field must be initialized before calling this function. phchassis Pointer to a handler to the opened chassis. This handler has to be used to query the property values of its chassis. Copyright Datapath Ltd Page - 11

12 HWMCloseChassis HWMCloseChassis ( HANDLE hchassis ) This function closes a connection to a chassis that has previously been opened by HWMOpenChassis. Any resources consumed by opening the chassis are released. hchassis Handler to the chassis we want to close. Copyright Datapath Ltd Page - 12

13 HWMIsChassisParameterSupported HWMIsChassisParameterSupported ( HANDLE hchassis, CHASSIS_PARAM param, BOOL *pbsupported ) This function checks whether a property is supported in the hardware identified by the handler. The handler has to be a valid handler obtained by HWMOpenChassis function. The property is indicated by a variable of type CHASSIS_PARAM. hchassis Handler to the chassis we want to query. param A variable of type CHASSIS_PARAM which indicates the parameter to be queried. For more details see CHASSIS_PARAM in this document. pbsupported A pointer to a variable which will hold a truth value to indicate whether the parameter is supported. Copyright Datapath Ltd Page - 13

14 HWMGetChassisParameterMinimum HWMGetChassisParameterMinimum ( HANDLE hchassis, CHASSIS_PARAM param, signed long *pvalue ) This function retrieves the minimum value of a supported property for an opened chassis. The property is indicated by a variable of type CHASSIS_PARAM. hchassis Handler to the chassis we want to query. param A variable of type CHASSIS_PARAM which indicates the parameter to be queried. For more details see CHASSIS_PARAM in this document. pvalue A pointer to a variable which will hold the minimum value. Copyright Datapath Ltd Page - 14

15 HWMGetChassisParameterMaximum HWMGetChassisParameterMaximum ( HANDLE hchassis, CHASSIS_PARAM param, signed long *pvalue ) This function retrieves the maximum value of a supported property for an opened chassis. The property is indicated by a variable of type CHASSIS_PARAM. hchassis Handler to the chassis we want to query. param A variable of type CHASSIS_PARAM which indicates the parameter to be queried. For more details see CHASSIS_PARAM in this document. pvalue A pointer to a variable which will hold the maximum value. Copyright Datapath Ltd Page - 15

16 HWMGetChassisParameter HWMGetChassisParameterMinimum ( HANDLE hchassis, CHASSIS_PARAM param, signed long *pvalue ) This function retrieves the current value of a supported property for an opened chassis. The property is indicated by a variable of type CHASSIS_PARAM. hchassis Handler to the chassis we want to query. param A variable of type CHASSIS_PARAM which indicates the parameter to be queried. For more details see CHASSIS_PARAM in this document. pvalue A pointer to a variable which will hold the current value. Copyright Datapath Ltd Page - 16

17 HWMRegisterChassisStatusCB HWMRegisterChassisStatusCB ( HANDLE hchassis, unsigned int numparam PCHASSIS_PARAM pparamarray, PCHASSISSTATUS *pcallbackfnarray ) This function sets callback function(s) to one or more parameters for an opened chassis. The function will be called if there are any changes in the value of a given parameter. hchassis Handler to the chassis we want to set the call back function(s). numparam The number of call back functions we are setting. pparamarray An array holding the CHASSIS_PARAM(s) for which the call back function(s) will be set. For more details see CHASSIS_PARAM in this document. pcallbackfnarray A pointer to an array holding the call back function(s) of type CHASSISSTATUS. One for each element in pparamarray. If only one call back function is defined, this will be set for all the elements in pparamarray. For more details see CHASSISSTATUS in this document. Copyright Datapath Ltd Page - 17

18 HWMGetCPUCount HWMGetCPUCount ( *pcpucount ) This function retrieves the number of CPUs in the system. pcpucount Pointer to a variable which will hold the number of CPUs. Copyright Datapath Ltd Page - 18

19 HWMOpenCPU HWMOpenCPU ( PCPU_DESCRIPTOR popendescriptor, HANDLE *phcpu ) This function opens a CPU, creates the necessary resources and creates a handler for the CPU so this handler can be used by other functions to query property values. popendescriptor This parameter refers to a structure of type CPU_DESCRIPTOR which is used to identify the CPU to be opened. For more details see CPU_DESCRIPTOR in this document. The size field must be initialized before calling this function. phcpu Pointer to a handler to the opened CPU. This handler has to be used to query the property values of its CPU. Copyright Datapath Ltd Page - 19

20 HWMCloseCPU HWMCloseCPU ( HANDLE hcpu ) This function closes a connection to a CPU that has previously been opened by HWMOpenCPU. Any resources consumed by opening the CPU are released. hcpu Handler to the CPU we want to close. Copyright Datapath Ltd Page - 20

21 HWMIsCPUParameterSupported HWMIsCPUParameterSupported ( HANDLE hcpu, CPU_PARAM param, BOOL *pbsupported ) This function checks whether a property is supported in the hardware identified by the handler. The handler has to be a valid handler obtained by HWMOpenCPU function. The property is indicated by a variable of type CPU_PARAM. hcpu Handler to the CPU we want to query. param A variable of type CPU_PARAM which indicates the parameter to be queried. For more details see CPU_PARAM in this document. pbsupported A pointer to a variable which will hold a truth value to indicate whether the parameter is supported. Copyright Datapath Ltd Page - 21

22 HWMGetCPUParameterMinimum HWMGetCPUParameterMinimum ( HANDLE hcpu, CPU_PARAM param, signed long *pvalue ) This function retrieves the minimum value of a supported property for an opened CPU. The property is indicated by a variable of type CPU_PARAM. hcpu Handler to the CPU we want to query. param A variable of type CPU_PARAM which indicates the parameter to be queried. For more details see CPU_PARAM in this document. pvalue A pointer to a variable which will hold the minimum value. Copyright Datapath Ltd Page - 22

23 HWMGetCPUParameterMaximum HWMGetCPUParameterMaximum ( HANDLE hcpu, CPU_PARAM param, signed long *pvalue ) This function retrieves the maximum value of a supported property for an opened CPU. The property is indicated by a variable of type CPU_PARAM. hcpu Handler to the CPU we want to query. param A variable of type CPU_PARAM which indicates the parameter to be queried. For more details see CPU_PARAM in this document. pvalue A pointer to a variable which will hold the maximum value. Copyright Datapath Ltd Page - 23

24 HWMGetCPUParameter HWMGetCPUParameterMinimum ( HANDLE hcpu, CPU_PARAM param, signed long *pvalue ) This function retrieves the current value of a supported property for an opened CPU. The property is indicated by a variable of type CPU_PARAM. hcpu Handler to the CPU we want to query. param A variable of type CPU_PARAM which indicates the parameter to be queried. For more details see CPU_PARAM in this document. pvalue A pointer to a variable which will hold the current value. Copyright Datapath Ltd Page - 24

25 HWMRegisterCPUStatusCB HWMRegisterCPUStatusCB ( HANDLE hcpu, unsigned int numparam PCPU_PARAM pparamarray, PCPUTATUS *pcallbackfnarray ) This function sets callback function(s) to one or more parameters for an opened chassis. The function will be called if there are any changes in the value of a given parameter. hcpu Handler to the CPU we want to set the call back function(s). numparam The number of call back functions we are setting. pparamarray An array holding the CPU_PARAM(s) for which the call back function(s) will be set. For more details see CPU_PARAM in this document. pcallbackfnarray A pointer to an array holding the call back function(s) of type CPUSTATUS. One for each element in pparamarray. If only one call back function is defined, this will be set for all the elements in pparamarray. For more details see CPUSTATUS in this document. Copyright Datapath Ltd Page - 25

26 HWMGetGPUCount HWMGetGPUCount ( *pgpucount ) This function retrieves the number of GPUs in the system. pgpucount Pointer to a variable which will hold the number of GPUs. Copyright Datapath Ltd Page - 26

27 HWMGetNumberGPUPerCard HWMGetNumberGPUPerCard ( *pgpupercard ) This function retrieves the number of GPUs per card. pgpupercard Pointer to a variable which will hold the number of GPUs per card. Copyright Datapath Ltd Page - 27

28 HWMGetGPUCardType HWMGetGPUCardType ( GPU_CARD_TYPE *pcardtype ) This function retrieves the type of graphics card on the system. pcardtype Pointer to a variable which will hold a value of type GPU_CARD_TYPE. For more details see GPU_CARD_TYPE in this document. Copyright Datapath Ltd Page - 28

29 HWMOpenGPU HWMOpenGPU ( PGPU_DESCRIPTOR popendescriptor, HANDLE *phgpu ) This function opens a GPU, creates the necessary resources and creates a handler for the GPU so this handler can be used by other functions to query property values. popendescriptor This parameter refers to a structure of type GPU_DESCRIPTOR which is used to identify the GPU to be opened. For more details see GPU_DESCRIPTOR in this document. The size field must be initialized before calling this function. phgpu Pointer to a handler to the opened GPU. This handler has to be used to query the property values of its GPU. Copyright Datapath Ltd Page - 29

30 HWMCloseGPU HWMCloseGPU ( HANDLE hgpu ) This function closes a connection to a GPU that has previously been opened by HWMOpenGPU. Any resources consumed by opening the GPU are released. hgpu Handler to the GPU we want to close. Copyright Datapath Ltd Page - 30

31 HWMIsGPUParameterSupported HWMIsGPUParameterSupported ( HANDLE hgpu, GPU_PARAM param, BOOL *pbsupported ) This function checks whether a property is supported in the hardware identified by the handler. The handler has to be a valid handler obtained by HWMOpenGPU function. The property is indicated by a variable of type GPU_PARAM. hgpu Handler to the GPU we want to query. param A variable of type GPU_PARAM which indicates the parameter to be queried. For more details see GPU_PARAM in this document. pbsupported A pointer to a variable which will hold a truth value to indicate whether the parameter is supported. Copyright Datapath Ltd Page - 31

32 HWMGetGPUParameterMinimum HWMGetGPUParameterMinimum ( HANDLE hgpu, GPU_PARAM param, signed long *pvalue ) This function retrieves the minimum value of a supported property for an opened GPU. The property is indicated by a variable of type GPU_PARAM. hgpu Handler to the GPU we want to query. param A variable of type GPU_PARAM which indicates the parameter to be queried. For more details see GPU_PARAM in this document. pvalue A pointer to a variable which will hold the minimum value. Copyright Datapath Ltd Page - 32

33 HWMGetGPUParameterMaximum HWMGetGPUParameterMaximum ( HANDLE hgpu, GPU_PARAM param, signed long *pvalue ) This function retrieves the maximum value of a supported property for an opened GPU. The property is indicated by a variable of type GPU_PARAM. hgpu Handler to the GPU we want to query. param A variable of type GPU_PARAM which indicates the parameter to be queried. For more details see GPU_PARAM in this document. pvalue A pointer to a variable which will hold the maximum value. Copyright Datapath Ltd Page - 33

34 HWMGetGPUParameter HWMGetGPUParameterMinimum ( HANDLE hgpu, GPU_PARAM param, signed long *pvalue ) This function retrieves the current value of a supported property for an opened GPU. The property is indicated by a variable of type GPU_PARAM. hgpu Handler to the GPU we want to query. param A variable of type GPU_PARAM which indicates the parameter to be queried. For more details see GPU_PARAM in this document. pvalue A pointer to a variable which will hold the current value. Copyright Datapath Ltd Page - 34

35 HWMRegisterGPUStatusCB HWMRegisterGPUStatusCB ( HANDLE hgpu, unsigned int numparam PGPU_PARAM pparamarray, PGPUTATUS *pcallbackfnarray ) This function sets callback function(s) to one or more parameters for an opened GPU. The function will be called if there are any changes in the value of a given parameter. hgpu Handler to the GPU we want to set the call back function(s). numparam The number of call back functions we are setting. pparamarray An array holding the GPU_PARAM(s) for which the call back function(s) will be set. For more details see GPU_PARAM in this document. pcallbackfnarray A pointer to an array holding the call back function(s) of type GPUSTATUS. One for each element in pparamarray. If only one call back function is defined, this will be set for all the elements in pparamarray. For more details see GPUSTATUS in this document. Copyright Datapath Ltd Page - 35

36 HWMGetVisionCount HWMGetVisionCount ( *pdevicecount ) This function gets the number of Vision PCI devices active in the system. A Vision capture card may present one or more devices on the PCI bus. Each PCI device can have one or more inputs attached to it. The characteristics of each device can be queried through this SDK. pdevicecount Pointer to the variable which receives the number of Vision PCI Devices. Minimum Supported Driver This function is supported in Wall Monitor Driver V2.2.0 onwards. Wall Monitor Driver V2.2.0 was first released in Driver Install V2.3.0 Copyright Datapath Ltd Page - 36

37 HWMGetVisionParameter HWMGetVisionParameter ( deviceindex, VISION_PARAM param, Unsigned long *pvalue ) This function gets the requested parameter from the device selected in the deviceindex. The parameters include the PCI bus, the temperature in degrees Celsius and the type of card. Early models of Vision capture card were not capable of monitoring the device temperature. This facility was introduced in the VisionAV and continues to be available in later cards. Where the temperature is not supported the card will return 0 o C. deviceindex The index (between 0 and less than devicecount) of the device to query. param One of the supported VISION_PARAM, documented later in this document, which selects the value to be returned. pvalue The pointer to the variable where the queried value will be stored. Minimum Supported Driver This function is supported in Wall Monitor Driver V2.2.0 onwards. Wall Monitor Driver V2.2.0 was first released in Driver Install V2.3.0 Copyright Datapath Ltd Page - 37

38 HWMGetVisionName HWMGetVisionName ( deviceindex, sizeinbytes, WCHAR *pname ) This function gets the OEM name of the Vision device from the driver. deviceindex The index (between 0 and less than devicecount) of the device to query. sizeinbytes The size of the buffer provided to store the name in bytes. pname The buffer in which the name is stored. If the buffer is not large enough the return code is HWMERROR_INSUFFICIENT_MEMORY. Minimum Supported Driver This function is supported in Wall Monitor Driver V2.4.0 onwards. Wall Monitor Driver V2.4.0 was first released in Driver Install V2.6.0 Copyright Datapath Ltd Page - 38

39 HWMGetLogicalDeviceLocation BOOLEAN HWMGetLogicalDeviceLocation ( UCHAR bus, UCHAR device, UCHAR *pucchassisindex, UCHAR *pucchassisslot, UCHAR *pucorderindex ) When an expansion card is installed in a Datapath backplane we can map the PCI address of the device onto a physical chassis and slot installed into the system. Given a bus and device this function tries to locate the physical chassis and PCIe slot the card is installed in. bus The bus portion of the address of the device on the PCI fabric. device The device portion of the address of the device on the PCI fabric. pucchassisindex The location of where the index of the chassis containing the card is stored. pucchassisslot The location where the index of the slot containing the card is stored. pucorderindex The location where the logical index of the device is stored. The physical ordering can differ from the logical ordering if the jumpers on the cards are used to order the devices. The return is a BOOLEAN and returns TRUE if the device is successfully located, FALSE otherwise. Minimum Supported Driver This function is supported in Wall Monitor Driver V2.4.0 onwards. Wall Monitor Driver V2.4.0 was first released in Driver Install V2.6.0 Copyright Datapath Ltd Page - 39

40 HWMGetSQXCount HWMGetSQXCount ( pcount) Gets the number of SQX cards. pcount Pointer to a variable that receives the number of SQX Cards. Copyright Datapath Ltd Page - 40

41 HWMGetSQXParameter HWMGetSQXParameter ( SQX_PARAM signed long ) Index, param, *pvalue Gets the card temperature for a given index. Index Index of the SQX Cards. Param The type of measurement. Type of measurements defined in the SQX_PARAM enumeration in HWM.h pvalue Pointer to the variable where the value will be put. Copyright Datapath Ltd Page - 41

42 HWMGetSQXName HWMGetSQXName ( (w)char Index, ulsize, *pvalue) Gets the card's name for a given index. Index Index of the SQX Card. ulsize Size of the name string in bytes. pvalue Pointer to the variable where the name string will be put. Copyright Datapath Ltd Page - 42

43 HWMonitor Enums, Structures and Callback Functions CHASSIS_PARAM typedef enum _CHASSIS_PARAM { CHASSIS_VOLTAGE_CPU_CORE, CHASSIS_VOLTAGE_CPU_CORE2, CHASSIS_VOLTAGE_VTT, CHASSIS_VOLTAGE_PLUS_3_3, CHASSIS_VOLTAGE_PLUS_5_0, CHASSIS_VOLTAGE_PLUS_12_0, CHASSIS_VOLTAGE_MINUS_5_0, CHASSIS_VOLTAGE_MINUS_12_0, CHASSIS_VOLTAGE_3VSB, CHASSIS_VOLTAGE_BATT, CHASSIS_BP_TEMPERATURE_LEFT, CHASSIS_BP_TEMPERATURE_CENTER, CHASSIS_BP_TEMPERATURE_RIGHT, CHASSIS_SBC_TEMPERATURE, CHASSIS_VOLTAGE_AVCC, CHASSIS_NUM_SUPPORTED_PARAMETERS, } CHASSIS_PARAM, *PCHASSIS_PARAM; CHASSIS_PARAM enumerates the properties a given chassis may support. Members CHASSIS_VOLTAGE_CPU_CORE Voltage of the CPU. CHASSIS_VOLTAGE_CPU_CORE2 Voltage of the second CPU. CHASSIS_VOLTAGE_VTT Voltage for the Integrated Memory Controller(IMC) CHASSIS_VOLTAGE_PLUS_3_ Voltage. CHASSIS_VOLTAGE_PLUS_5_ Voltage. CHASSIS_VOLTAGE_PLUS_12_ Voltage. CHASSIS_VOLTAGE_MINUS_5_0 Copyright Datapath Ltd Page - 43

44 -5.0 Voltage. CHASSIS_VOLTAGE_MINUS_12_ Voltage. CHASSIS_VOLTAGE_3VSB 3.0 Stand By voltage. CHASSIS_VOLTAGE_BATT Battery voltage. CHASSIS_BP_TEMPERATURE_LEFT Temperature of the Back Plane on the left, close to the Single Board Computer (SBC). CHASSIS_BP_TEMPERATURE_CENTER Temperature of the Back Plane on the center. CHASSIS_BP_TEMPERATURE_RIGHT Temperature of the Back Plane on the right, close to the power supply. CHASSIS_SBC_TEMPERATURE Temperature of the Single Board Computer. CHASSIS_VOLTAGE_AVCC Auxiliary supply voltage. CHASSIS_NUM_SUPPORTED_PARAMETERS Number of properties. Copyright Datapath Ltd Page - 44

45 CPU_PARAM typedef enum _CPU_PARAM { CPU_TEMPERATURE, CPU_FAN_SPEED, CPU_CORE_VOLTAGE, CPU_NUM_SUPPORTED_PARAMETERS, } CPU_PARAM, *PCPU_PARAM; CPU_PARAM enumerates the properties a given CPU may support. Members CPU_TEMPERATURE Voltage of the CPU core. CPU_FAN_SPEED CPU fan speed. CURRENTLY NOT SUPPORTED. CPU_CORE_VOLTAGE CPU core voltage. CURRENTLY NOT SUPPORTED. CPU_NUM_SUPPORTED_PARAMETERS Number of properties. Copyright Datapath Ltd Page - 45

46 GPU_PARAM typedef enum _GPU_PARAM { GPU_TEMPERATURE, GPU_FAN_SPEED, GPU_CORE_VOLTAGE, GPU_PCI_CARD_INDEX, GPU_PCI_CARD_HANDLE, GPU_NUM_SUPPORTED_PARAMETERS, } GPU_PARAM, *PGPU_PARAM; GPU_PARAM enumerates the properties a given GPU may support. Members GPU_TEMPERATURE Voltage of the CPU core. GPU_FAN_SPEED GPU fan speed. NOT CURRENTLY SUPPORTED. GPU_CORE_VOLTAGE GPU core voltage. NOT CURRENTLY SUPPORTED. GPU_PCI_CARD_INDEX Graphics card enumeration index. GPU_PCI_CARD_HANDLE Graphics card PCI bus information. GPU_NUM_SUPPORTED_PARAMETERS Number of properties. Copyright Datapath Ltd Page - 46

47 VISION_PARAM typedef enum _VISION_PARAM { VISION_TEMPERATURE, VISION_PCI_BUS, VISION_TYPE, VISION_MAX_TEMPERATURE, VISION_MIN_TEMPERATURE, VISION_PCI_INFO, VISION_NUM_SUPPORTED_PARAMETERS, } VISION_PARAM, *PVISION_PARAM; VISION_PARAM enumerates the properties that a given Vision device can support. Members VISION_TEMPERATURE The temperature of the Vision device core. VISION_PCI_BUS The PCI bus that has been allocated to the Vision device. VISION_TYPE The hardware device type identifier which can be used to identify the type of board. VISION_MAX_TEMPERATURE The maximum operating temperature of the Vision device. VISION_MIN_TEMPERATURE The minimum operating temperature of the Vision device. VISION_PCI_INFO The PCI address allocated to the Vision device. This parameter includes both the PCI bus, in the top 16 bits of the returned value, and the device address in the bottom 16 bits. Copyright Datapath Ltd Page - 47

48 SQX_PARAM typedef enum _SQX_PARAM { SQX_BOARD_TEMPERATURE, SQX_CORE_CPU_1_TEMPERATURE, SQX_CORE_CPU_2_TEMPERATURE, SQX_CORE_CPU_3_TEMPERATURE, SQX_CORE_CPU_4_TEMPERATURE, SQX_MAX_TEMPERATURE, SQX_MIN_TEMPERATURE, SQX_NUM_SUPPORTED_PARAMETERS, } SQX_PARAM, *PSQX_PARAM; SQX_PARAM enumerates the properties a given SQX card may support. Members SQX_BOARD_TEMPERATURE Temperature of the Board SQX_CORE_CPU_1_TEMPERATURE Temperature of the CPU Core 1 SQX_CORE_CPU_2_TEMPERATURE Temperature of the CPU Core 2 SQX_CORE_CPU_3_TEMPERATURE Temperature of the CPU Core 3 SQX_CORE_CPU_4_TEMPERATURE Temperature of the CPU Core 4 SQX_MAX_TEMPERATURE The maximum temperature SQX_MIN_TEMPERATURE The minimum temperature SQX_NUM_SUPPORTED_PARAMETERS Number of properties. Copyright Datapath Ltd Page - 48

49 SUPPORTED_PLATFORM typedef enum _SUPPORTED_PLATFORM { GENERIC_PLATFORM = 0, PORTWELL_8913_SBC, PORTWELL_8914_SBC, PORTWELL_8110_SBC, PORTWELL_8120_SBC }SUPPORTED_PLATFORM ; SUPPORTED_PLATFORM enumerates the possible Single Computer Board (SBC) a system may use. Members GENERIC_PLATFORM PORTWELL_8913_SBC Intel Core 2 Quad processor based PICMG 1.3 SHB PORTWELL_8914_SBC Not used in current systems. PORTWELL_8110_SBC Intel Core i5/i7 processor based PICMG 1.3 SHB PORTWELL_8120_SBC Not used in current systems. Copyright Datapath Ltd Page - 49

50 GPU_CARD_TYPE typedef enum _GPU_CARD_TYPE { CARD_CARD_GENERIC = 0, CARD_CARD_149, CARD_CARD_170 }GPU_CARD_TYPE ; GPU_CARD_TYPE enumerates the possible graphics cards a system may use. Members GPU_CARD_GENERIC GPU_CARD_149 Image4 graphics card. GPU_CARD_170 ImageDP4 graphics card. Copyright Datapath Ltd Page - 50

51 CHASSIS_DESCRIPTOR typedef struct _CHASSIS_DESCRIPTOR { unsigned int size; unsigned int chassisnumber; SUPPORTED_PLATFORM platform; } CHASSIS_DESCRIPTOR, *PCHASSIS_DESCRIPTOR; The CHASSIS_DESCRIPTOR structure describes the chassis so it can be opened by function HWMOpenChassis. Members size The size of the structure. chassisnumber This is the chassis number, it starts from zero. platform Platform type. Copyright Datapath Ltd Page - 51

52 CPU_DESCRIPTOR typedef struct _CPU_DESCRIPTOR { unsigned int size; unsigned int cpunumber; } CPU_DESCRIPTOR, *PCPU_DESCRIPTOR; The CPU_DESCRIPTOR structure describes the chassis so it can be opened by function HWMOpenCPU. Members size The size of the structure. cpunumber This is the CPU number, it starts from zero. Copyright Datapath Ltd Page - 52

53 GPU_DESCRIPTOR typedef struct _GPU_DESCRIPTOR { unsigned int size; unsigned int gpunumber; } GPU_DESCRIPTOR, *PGPU_DESCRIPTOR; The GPU_DESCRIPTOR structure describes the chassis so it can be opened by function HWMOpenGPU. Members size The size of the structure. gpunumber This is the GPU number, it starts from zero. Copyright Datapath Ltd Page - 53

54 HWMCHASSISSTATUS typedef (HWMCHASSISSTATUS)( HANDLE hchassis; CHASSIS_PARAM param; long value; ULONG_PTR userdata ); typedef HWMCHASSISSTATUS *PCHASSISSTATUS; The HWMCHASSISSTATUS function is an application-defined callback function. The HWMonitor SDK calls this function when the chassis property specified by param changes its value. hchassis Handler to the chassis which the callback function is defined. param The chassis property for which the callback function is defined. value The chassis property value. userdata Application supplied context. Copyright Datapath Ltd Page - 54

55 HWMCPUSTATUS typedef (HWMCPUSTATUS)( HANDLE hcpu; CPU_PARAM param; long value; ULONG_PTR userdata ); typedef HWMCPUSTATUS *PCPUSTATUS; The HWMCPUSTATUS function is an application-defined callback function. The HWMonitor SDK calls this function when thecpu property specified by param changes its value. hcpu Handler to the CPU which the callback function is defined. param The CPU property for which the callback function is defined. value The CPU property value. userdata Application supplied context. Copyright Datapath Ltd Page - 55

56 HWMGPUSTATUS typedef (HWMGPUSTATUS)( HANDLE hgpu; GPU_PARAM param; long value; ULONG_PTR userdata ); typedef HWMGPUSTATUS *PGPUSTATUS; The HWMGPUSTATUS function is an application-defined callback function. The HWMonitor SDK calls this function when thegpu property specified by param changes its value. hgpu Handler to the GPU which the callback function is defined. param The GPU property for which the callback function is defined. value The GPU property value. userdata Application supplied context. Copyright Datapath Ltd Page - 56