xpci3xxx: Watchdog

xpci3xxx 1.00.00

Macros
Watchdog

## Macros
#define | CMD_xpci3xxx_InitWatchdog _IOR(xpci3xxx_MAGIC, 120,long)
| Initialize the watchdog.
#define | CMD_xpci3xxx_ReleaseWatchdog _IOR(xpci3xxx_MAGIC, 121,long)
| Stops and frees the watchdog.
#define | CMD_xpci3xxx_StartWatchdog _IOR(xpci3xxx_MAGIC, 122,long)
| Start the selected watchdog.
#define | CMD_xpci3xxx_StartAllWatchdogs _IOR(xpci3xxx_MAGIC, 123,long)
| Start all initialized watchdogs.
#define | CMD_xpci3xxx_TriggerWatchdog _IOR(xpci3xxx_MAGIC, 124,long)
| Triggers the selected watchdog.
#define | CMD_xpci3xxx_TriggerAllWatchdogs _IOR(xpci3xxx_MAGIC, 125,long)
| Triggers all watchdogs.
#define | CMD_xpci3xxx_StopWatchdog _IOR(xpci3xxx_MAGIC, 126,long)
| Stop the selected watchdog.
#define | CMD_xpci3xxx_StopAllWatchdogs _IOR(xpci3xxx_MAGIC, 127,long)
| Stop all watchdogs.
#define | CMD_xpci3xxx_ReadWatchdogStatus _IOR(xpci3xxx_MAGIC, 128,long)
| Read the watchdogs status.
#define | CMD_xpci3xxx_ReadWatchdogValue _IOR(xpci3xxx_MAGIC, 129,long)
| Read the watchdog value.
#define | CMD_xpci3xxx_EnableDisableWatchdogInterrupt _IOR(xpci3xxx_MAGIC, 130,long)
| Enable/disable the watchdog interrupt.
#define | CMD_xpci3xxx_EnableDisableWatchdogHardwareOutput _IOR(xpci3xxx_MAGIC, 131,long)
| Enable/disable the watchdog hardware output.
#define | CMD_xpci3xxx_GetWatchdogHardwareOutputStatus _IOR(xpci3xxx_MAGIC, 132,long)
| Return the status of the hardware watchdog output.

## Detailed Description

## Macro Definition Documentation

## ◆ CMD_xpci3xxx_EnableDisableWatchdogHardwareOutput

#define CMD_xpci3xxx_EnableDisableWatchdogHardwareOutput _IOR(xpci3xxx_MAGIC, 131,long)

Enable/disable the watchdog hardware output.

Parameters

  [in] | uint8_t | arg[3] Parameters

- arg[0] Selected watchdog number
- arg[1] Control flag = ADDIDATA_DISABLE | ADDIDATA_ENABLE
- arg[3] Output level on watchdog overflow = ADDIDATA_HIGH : output to high | ADDIDATA_LOW : output to low

Return values

  0 | : Success
  1 | : Internal error
  2 | : Watchdog not intialised
  3 | : Wrong Watchdog number
  4 | : Watchdog already configured as timer
  5 | : Watchdog already used as counter
  6 | : Wrong output flag
  7 | : Wrong output level

Definition at line 1744 of file xpci3xxx.h.

## ◆ CMD_xpci3xxx_EnableDisableWatchdogInterrupt

#define CMD_xpci3xxx_EnableDisableWatchdogInterrupt _IOR(xpci3xxx_MAGIC, 130,long)

Enable/disable the watchdog interrupt.

uint8_t arg[2] Parameters

- arg[0] Selected watchdog number
- arg[1] Control flag = ADDIDATA_DISABLE | ADDIDATA_ENABLE

Return values

  0 | : Success
  1 | : Internal error
  2 | : Watchdog not intialised
  3 | : Wrong watchdog number
  4 | : Watchdog already configured as timer
  5 | : Watchdog already used as counter
  6 | : Wrong interrupt flag
  7 | : Interrupt Callback not installed

Definition at line 1724 of file xpci3xxx.h.

## ◆ CMD_xpci3xxx_GetWatchdogHardwareOutputStatus

#define CMD_xpci3xxx_GetWatchdogHardwareOutputStatus _IOR(xpci3xxx_MAGIC, 132,long)

Return the status of the hardware watchdog output.

Parameters

  [in,out] | uint8_t | arg[2]

- arg[0] (in ) Selected watchdog number
- arg[1] (out) Hardware output status = 0 : not activate | 1 : activate

Return values

  0 | : No error occur
  1 | : Internal error
  2 | : Watchdog not intialised
  3 | : Wrong Watchdog number
  4 | : Watchdog as timer already used
  5 | : Watchdog already used as counter

Definition at line 1760 of file xpci3xxx.h.

## ◆ CMD_xpci3xxx_InitWatchdog

#define CMD_xpci3xxx_InitWatchdog _IOR(xpci3xxx_MAGIC, 120,long)

Initialize the watchdog.

Parameters

  [in] | uint32_t | *arg Parameters

- arg[0] Selected watchdog number
- arg[1] Watchdog Time Unit = 0 : nanosecond | 1 : microsecond | 2 : millisecond | 3 : second
- arg[2] Watchdog reload value

Return values

  0 | : Success
  1 | : Internal error
  2 | : Wrong watchdog number
  3 | : Watchdog already configured as timer
  4 | : Watchdog already used as counter
  5 | : Wrong time unit
  6 | : Wrong reload value

Definition at line 1590 of file xpci3xxx.h.

## ◆ CMD_xpci3xxx_ReadWatchdogStatus

#define CMD_xpci3xxx_ReadWatchdogStatus _IOR(xpci3xxx_MAGIC, 128,long)

Read the watchdogs status.

Parameters

  [in,out] | uint8_t | arg[4] Parameter and result

- arg[0] Selected watchdog number
- arg[1] Overflow status = 0 : none | 1 : occurred
- arg[2] Software Trigger Status = 0 : none | 1 : occurred
- arg[3] Hardware Trigger Status = 0 : none | 1 : occurred

Return values

  0 | : Success
  1 | : Internal error
  2 | : Watchdog not initialized
  3 | : Wrong watchdog number
  4 | : Watchdog already configured as timer
  5 | : Watchdog already used as counter

Definition at line 1689 of file xpci3xxx.h.

## ◆ CMD_xpci3xxx_ReadWatchdogValue

#define CMD_xpci3xxx_ReadWatchdogValue _IOR(xpci3xxx_MAGIC, 129,long)

Read the watchdog value.

Parameters

  [in,out] | uint32_t | arg[2]

- arg[0] (in) Selected watchdog number
- arg[1] Current watchdog value

Return values

  0 | : Success
  1 | : Internal error
  2 | : Watchdog not intialised
  3 | : Wrong watchdog number
  4 | : Watchdog already configured as timer
  5 | : Watchdog already used as counter

Definition at line 1705 of file xpci3xxx.h.

## ◆ CMD_xpci3xxx_ReleaseWatchdog

#define CMD_xpci3xxx_ReleaseWatchdog _IOR(xpci3xxx_MAGIC, 121,long)

Stops and frees the watchdog.

Parameters

  [in] | uint8_t | *arg Selected watchdog number

Return values

  0 | : Success
  1 | : Internal error
  2 | : Watchdog not intialised
  3 | : Wrong watchdog number
  4 | : Watchdog already configured as timer
  5 | : Watchdog already used as counter

Definition at line 1603 of file xpci3xxx.h.

## ◆ CMD_xpci3xxx_StartAllWatchdogs

#define CMD_xpci3xxx_StartAllWatchdogs _IOR(xpci3xxx_MAGIC, 123,long)

Start all initialized watchdogs.

Parameters

  NULL | (ignored)

Return values

  0 | : Success
  1 | : Internal error

Definition at line 1626 of file xpci3xxx.h.

## ◆ CMD_xpci3xxx_StartWatchdog

#define CMD_xpci3xxx_StartWatchdog _IOR(xpci3xxx_MAGIC, 122,long)

Start the selected watchdog.

Parameters

  [in] | uint8_t | *arg Selected watchdog number

Return values

  0 | : Success
  1 | : Internal error
  2 | : Watchdog not intialised
  3 | : Wrong watchdog number
  4 | : Watchdog already configured as timer
  5 | : Watchdog already used as counter

Definition at line 1616 of file xpci3xxx.h.

## ◆ CMD_xpci3xxx_StopAllWatchdogs

#define CMD_xpci3xxx_StopAllWatchdogs _IOR(xpci3xxx_MAGIC, 127,long)

Stop all watchdogs.

Parameters

  NULL | (ignored)

Return values

  0 | : Success
  1 | : Internal error

Definition at line 1671 of file xpci3xxx.h.

## ◆ CMD_xpci3xxx_StopWatchdog

#define CMD_xpci3xxx_StopWatchdog _IOR(xpci3xxx_MAGIC, 126,long)

Stop the selected watchdog.

Parameters

  [in] | uint8_t | *arg Selected watchdog number

Return values

  0 | : Success
  1 | : Internal error
  2 | : Watchdog not intialised
  3 | : Wrong watchdog number
  4 | : Watchdog already configured as timer
  5 | : Watchdog already used as counter

Definition at line 1662 of file xpci3xxx.h.

## ◆ CMD_xpci3xxx_TriggerAllWatchdogs

#define CMD_xpci3xxx_TriggerAllWatchdogs _IOR(xpci3xxx_MAGIC, 125,long)

Triggers all watchdogs.

Parameters

  NULL | (ignored)

Return values

  0 | : Success
  1 | : Internal error

Definition at line 1648 of file xpci3xxx.h.

## ◆ CMD_xpci3xxx_TriggerWatchdog

#define CMD_xpci3xxx_TriggerWatchdog _IOR(xpci3xxx_MAGIC, 124,long)

Triggers the selected watchdog.

Parameters

  [in] | uint8_t | *arg Selected watchdog number

Return values

  0 | : Success
  1 | : Internal error
  2 | : Watchdog not intialised
  3 | : Wrong watchdog number
  4 | : Watchdog already configured as timer
  5 | : Watchdog already used as counter

Definition at line 1639 of file xpci3xxx.h.