xPCIe1516 API
xPCIe1516 Watchdog functions

Functions

_INT_ i_PCIe1516_InitAndStartWatchdog (IN HANDLE h_DeviceHandle, IN WORD w_ReloadValue, IN BYTE b_TimeBase)
 
_INT_ i_PCIe1516_ReadWatchdogValue (IN HANDLE h_DeviceHandle, OUT WORD *w_Value)
 
_INT_ i_PCIe1516_ReadWatchdogStatus (IN HANDLE h_DeviceHandle, OUT BYTE *b_Status, OUT BYTE *b_SoftwareTriggerStatus)
 
_INT_ i_PCIe1516_TriggerWatchdog (IN HANDLE h_DeviceHandle)
 
_INT_ i_PCIe1516_StopAndReleaseWatchdog (IN HANDLE h_DeviceHandle)
 

Detailed Description

Function Documentation

_INT_ i_PCIe1516_InitAndStartWatchdog ( IN HANDLE  h_DeviceHandle,
IN WORD  w_ReloadValue,
IN BYTE  b_TimeBase 
)

Initializes and starts the watchdog of the board

Parameters
[in]h_DeviceHandleHandle of the board
[in]w_ReloadValueWatchdog reload value (1..0xFFF)
[in]b_TimeBaseTime base of the watchdog (0 for microseconds, 1 for milliseconds and 2 for seconds) (0..2)
Return values
0No error
-1The h_DeviceHandle parameter is wrong
-2The w_ReloadValue parameter is wrong
-3The b_TimeBase parameter is wrong
-100An error occurred while calling the IOCTL function
_INT_ i_PCIe1516_ReadWatchdogValue ( IN HANDLE  h_DeviceHandle,
OUT WORD *  w_Value 
)

Reads the value of the watchdog of the board

Parameters
[in]h_DeviceHandleHandle of the board
[out]w_ValueCurrent value of the watchdog
Return values
0No error
-1The h_DeviceHandle parameter is wrong
-100An error occurred while calling the IOCTL function
_INT_ i_PCIe1516_ReadWatchdogStatus ( IN HANDLE  h_DeviceHandle,
OUT BYTE *  b_Status,
OUT BYTE *  b_SoftwareTriggerStatus 
)

Reads the status of the watchdog of the board

Parameters
[in]h_DeviceHandleHandle of the board
[out]b_StatusCurrent status of the watchdog (0: disabled, 1: enabled)
[out]b_SoftwareTriggerStatusCurrent status of the software trigger (0: no trigger occured, 1: a trigger occured)
Return values
0No error
-1The h_DeviceHandle parameter is wrong
-100An error occurred while calling the IOCTL function
_INT_ i_PCIe1516_TriggerWatchdog ( IN HANDLE  h_DeviceHandle)

Triggers the watchdog

Parameters
[in]h_DeviceHandleHandle of the board
Return values
0No error
-1The h_DeviceHandle parameter is wrong
-100An error occurred while calling the IOCTL function
_INT_ i_PCIe1516_StopAndReleaseWatchdog ( IN HANDLE  h_DeviceHandle)

Stops and releases the watchdog of the board

Parameters
[in]h_DeviceHandleHandle of the board
Return values
0No error
-1The h_DeviceHandle parameter is wrong
-100An error occurred while calling the IOCTL function