Search by Tags

Watchdog Software Library API

 

Article updated at 28 Oct 2017
Compare with Revision


Subscribe for this article updates

This article describes the Watchdog software library API and provides a functional overview

Defines

#define  WATCHDOG_VER_MAJ  1
Major Library Version.
#define  WATCHDOG_VER_MIN  0
Library Subversion.
#define  WATCHDOG_VER_BUILD  0
Library Build.

Functions

void  WatchdogGetLibVersion (DWORD *pVerMaj, DWORD *pVerMin, DWORD *pBuild)
BOOL  WatchdogInit ()
BOOL  WatchdogDeinit ()
BOOL  WatchdogRetrigger (DWORD Timeout_ms)

Detailed Description

WatchDog Support Library.

Author:
kia, $Author$
Version:
$Rev$
Date:
$Date$
Target Platforms:
Colibri PXA320, Windows CE 6.0
Caveats:
The watchdog does not work on PXA270 due to bug in the PXA270 CPU.

Define Documentation

#define WATCHDOG_VER_BUILD  0

Library Build.

#define WATCHDOG_VER_MAJ  1

Major Library Version.

#define WATCHDOG_VER_MIN  0

Library Subversion.


Function Documentation

BOOL WatchdogDeinit ( )

Deactivates watchdog This is not possible, therefore the function always returns FALSE

Return values:
TRUE success
FALSE error
void WatchdogGetLibVersion ( DWORD *  pVerMaj,
DWORD *  pVerMin,
DWORD *  pBuild
)

returns the version of this library

Parameters:
[out] pVerMaj Main Version of this library
[out] pVerMin Subversion of this library
[out] pBuild Build Number of this library
BOOL WatchdogInit ( )

Activates the watchdog, and sets the Watchdog timer to the maximum timeout: 2^32 ticks / 3.125MHz = 1'374sec = 23min.

Return values:
TRUE success
FALSE error
BOOL WatchdogRetrigger ( DWORD  Timeout_ms )

Retriggers Watchdog

Parameters:
[in] Timeout_ms A hardware reset will be done if the Watchdog is not retriggered within this time [ms]
valid range: 1...1'374'389
Return values:
TRUE success
FALSE error