Zephyr API Documentation 4.4.0-rc2
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
Watchdog Driver Backend API

Data Structures

struct  wdt_driver_api
  Driver Operations Watchdog driver operations More...

Typedefs

typedef int(* wdt_api_setup) (const struct device *dev, uint8_t options)
 Callback API to set up a watchdog instance.
typedef int(* wdt_api_disable) (const struct device *dev)
 Callback API to disable a watchdog instance.
typedef int(* wdt_api_install_timeout) (const struct device *dev, const struct wdt_timeout_cfg *cfg)
 Callback API to install a new timeout.
typedef int(* wdt_api_feed) (const struct device *dev, int channel_id)
 Callback API to feed a specified watchdog timeout.

Detailed Description

This group contains the API type definitions, callback signatures, and other helpers required to implement a Watchdog driver.

Typedef Documentation

◆ wdt_api_disable

typedef int(* wdt_api_disable) (const struct device *dev)

#include <zephyr/drivers/watchdog.h>

Callback API to disable a watchdog instance.

See wdt_disable() for argument description.

◆ wdt_api_feed

typedef int(* wdt_api_feed) (const struct device *dev, int channel_id)

#include <zephyr/drivers/watchdog.h>

Callback API to feed a specified watchdog timeout.

See wdt_feed() for argument description.

◆ wdt_api_install_timeout

typedef int(* wdt_api_install_timeout) (const struct device *dev, const struct wdt_timeout_cfg *cfg)

#include <zephyr/drivers/watchdog.h>

Callback API to install a new timeout.

See wdt_install_timeout() for argument description.

◆ wdt_api_setup

typedef int(* wdt_api_setup) (const struct device *dev, uint8_t options)

#include <zephyr/drivers/watchdog.h>

Callback API to set up a watchdog instance.

See wdt_setup() for argument description.