Timer / Counter Driver APIs

Watchdog Interface

group watchdog_interface

Watchdog Interface.

Deprecated Watchdog API types.

enum wdt_mode

Values:

WDT_MODE_RESET = 0
WDT_MODE_INTERRUPT_RESET
enum wdt_clock_timeout_cycles

WDT clock cycles for timeout type.

Values:

WDT_2_16_CYCLES
WDT_2_17_CYCLES
WDT_2_18_CYCLES
WDT_2_19_CYCLES
WDT_2_20_CYCLES
WDT_2_21_CYCLES
WDT_2_22_CYCLES
WDT_2_23_CYCLES
WDT_2_24_CYCLES
WDT_2_25_CYCLES
WDT_2_26_CYCLES
WDT_2_27_CYCLES
WDT_2_28_CYCLES
WDT_2_29_CYCLES
WDT_2_30_CYCLES
WDT_2_31_CYCLES
WDT_MODE
WDT_MODE_OFFSET
WDT_TIMEOUT_MASK

Watchdog Reset Behavior.

Reset behavior after timeout.

WDT_FLAG_RESET_NONE

No reset

WDT_FLAG_RESET_CPU_CORE

CPU core reset

WDT_FLAG_RESET_SOC

Global SoC reset

Defines

WDT_OPT_PAUSE_IN_SLEEP

Pause watchdog timer when CPU is in sleep state.

WDT_OPT_PAUSE_HALTED_BY_DBG

Pause watchdog timer when CPU is halted by the debugger.

WDT_FLAG_RESET_SHIFT

Watchdog reset flag bit field mask shift.

WDT_FLAG_RESET_MASK

Watchdog reset flag bit field mask.

Typedefs

typedef void (*wdt_callback_t)(struct device *dev, int channel_id)

Watchdog callback.

typedef wdt_api_setup

Callback API for setting up watchdog instance. See wdt_setup() for argument descriptions.

typedef wdt_api_disable

Callback API for disabling watchdog instance. See wdt_disable() for argument descriptions.

typedef wdt_api_install_timeout

Callback API for installing new timeout. See wdt_install_timeout() for argument descriptions.

typedef wdt_api_feed

Callback API for feeding specified watchdog timeout. See (wdt_feed) for argument descriptions.

typedef wdt_api_enable

Callback API for enabling watchdog. See wdt_enable() for argument descriptions. Please note that this function is deprecated.

typedef wdt_api_get_config

Callback API for getting current watchdog configuration. See wdt_get_config() for argument descriptions. Please note that this function is deprecated.

typedef wdt_api_set_config

Callback API for setting current watchdog configuration. See wdt_set_config() for argument descriptions. Please note that this function is deprecated.

typedef wdt_api_reload

Callback API for reloading watchdog. See wdt_reload() for argument descriptions. Please note that this function is deprecated.

Functions

static int wdt_setup(struct device *dev, u8_t options)

Set up watchdog instance.

This function is used for configuring global watchdog settings that affect all timeouts. It should be called after installing timeouts. After successful return, all installed timeouts are valid and must be serviced periodically by calling wdt_feed().

Parameters
  • dev: Pointer to the device structure for the driver instance.
  • options: Configuration options as defined by the WDT_OPT_* constants
Return Value
  • 0: If successful.
  • -ENOTSUP: If any of the set options is not supported.
  • -EBUSY: If watchdog instance has been already setup.

static int wdt_disable(struct device *dev)

Disable watchdog instance.

This function disables the watchdog instance and automatically uninstalls all timeouts. To set up a new watchdog, install timeouts and call wdt_setup() again. Not all watchdogs can be restarted after they are disabled.

Parameters
  • dev: Pointer to the device structure for the driver instance.
Return Value
  • 0: If successful.
  • -EFAULT: If watchdog instance is not enabled.
  • -EPERM: If watchdog can not be disabled directly by application code.

static int wdt_install_timeout(struct device *dev, const struct wdt_timeout_cfg *cfg)

Install new timeout.

This function must be used before wdt_setup(). Changes applied here have no effects until wdt_setup() is called.

Parameters
  • dev: Pointer to the device structure for the driver instance.
  • cfg: Pointer to timeout configuration structure.
Return Value
  • channel_id: If successful, a non-negative value indicating the index of the channel to which the timeout was assigned. This value is supposed to be used as the parameter in calls to wdt_feed().
  • -EBUSY: If timeout can not be installed while watchdog has already been setup.
  • -ENOMEM: If no more timeouts can be installed.
  • -ENOTSUP: If any of the set flags is not supported.
  • -EINVAL: If any of the window timeout value is out of possible range. This value is also returned if watchdog supports only one timeout value for all timeouts and the supplied timeout window differs from windows for alarms installed so far.

static int wdt_feed(struct device *dev, int channel_id)

Feed specified watchdog timeout.

Parameters
  • dev: Pointer to the device structure for the driver instance.
  • channel_id: Index of the fed channel.
Return Value
  • 0: If successful.
  • -EINVAL: If there is no installed timeout for supplied channel.

static void wdt_enable(struct device *dev)
static void wdt_get_config(struct device *dev, struct wdt_config *config)
static int wdt_set_config(struct device *dev, struct wdt_config *config)
static void wdt_reload(struct device *dev)
struct wdt_config
#include <watchdog.h>

WDT configuration struct.

struct wdt_window
#include <watchdog.h>

Watchdog timeout window.

Each installed timeout needs feeding within the specified time window, otherwise the watchdog will trigger. If the watchdog instance does not support window timeouts then min value must be equal to 0.

Note
If specified values can not be precisely set they are always rounded up.
Parameters
  • min: Lower limit of watchdog feed timeout in milliseconds.
  • max: Upper limit of watchdog feed timeout in milliseconds.

struct wdt_timeout_cfg
#include <watchdog.h>

Watchdog timeout configuration struct.

Parameters
  • window: Timing parameters of watchdog timeout.
  • callback: Timeout callback. Passing NULL means that no callback will be run.
  • next: Pointer to the next timeout configuration. This pointer is used for watchdogs with staged timeouts functionality. Value must be NULL for single stage timeout.
  • flags: Bit field with following parts: 
    reset        [ 0 : 1 ]   - perform specified reset after timeout/callback