Search by Tags

Watchdog Lib API

 

Article updated at 28 Oct 2017
Subscribe for this article updates

Attention: this is a legacy library and thus not supported by Toradex anymore. We recommend that you use the new libraries for all Toradex modules. Please see the Toradex CE Libraries and Code Samples for up-to-date information.

WatchDog Support Library.

Macros

#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 (void)
BOOL  WatchdogDeinit (void)
BOOL  WatchdogRetrigger (DWORD Timeout_ms)

Detailed Description

WatchDog Support Library.

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

Macro Definition 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 ( void  )

Deactivate 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 ( void  )

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 )

Retrigger 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