watchdog.h

Go to the documentation of this file.

/*
 * Copyright (c) 2017 Nordic Semiconductor ASA
 * Copyright (c) 2015 Intel Corporation
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_DRIVERS_WATCHDOG_H_
#define ZEPHYR_INCLUDE_DRIVERS_WATCHDOG_H_
 
#include <zephyr/types.h>
#include <zephyr/sys/util.h>
#include <zephyr/device.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define WDT_OPT_PAUSE_IN_SLEEP          BIT(0)
 
#define WDT_OPT_PAUSE_HALTED_BY_DBG     BIT(1)
 
#define WDT_FLAG_RESET_SHIFT            (0)
#define WDT_FLAG_RESET_MASK             (0x3 << WDT_FLAG_RESET_SHIFT)
#define WDT_FLAG_RESET_NONE             (0 << WDT_FLAG_RESET_SHIFT)
#define WDT_FLAG_RESET_CPU_CORE         (1 << WDT_FLAG_RESET_SHIFT)
#define WDT_FLAG_RESET_SOC              (2 << WDT_FLAG_RESET_SHIFT)
 
struct wdt_window {
        uint32_t min;
        uint32_t max;
};
 
typedef void (*wdt_callback_t)(const struct device *dev, int channel_id);
 
struct wdt_timeout_cfg {
        struct wdt_window window;
        wdt_callback_t callback;
#if defined(CONFIG_WDT_MULTISTAGE) || defined(__DOXYGEN__)
        struct wdt_timeout_cfg *next;
#endif
        uint8_t flags;
};
 
typedef int (*wdt_api_setup)(const struct device *dev, uint8_t options);
 
typedef int (*wdt_api_disable)(const struct device *dev);
 
typedef int (*wdt_api_install_timeout)(const struct device *dev,
                                       const struct wdt_timeout_cfg *cfg);
 
typedef int (*wdt_api_feed)(const struct device *dev, int channel_id);
 
__subsystem struct wdt_driver_api {
        wdt_api_setup setup;
        wdt_api_disable disable;
        wdt_api_install_timeout install_timeout;
        wdt_api_feed feed;
};
__syscall int wdt_setup(const struct device *dev, uint8_t options);
 
static inline int z_impl_wdt_setup(const struct device *dev, uint8_t options)
{
        const struct wdt_driver_api *api =
                (const struct wdt_driver_api *)dev->api;
 
        return api->setup(dev, options);
}
 
__syscall int wdt_disable(const struct device *dev);
 
static inline int z_impl_wdt_disable(const struct device *dev)
{
        const struct wdt_driver_api *api =
                (const struct wdt_driver_api *)dev->api;
 
        return api->disable(dev);
}
 
static inline int wdt_install_timeout(const struct device *dev,
                                      const struct wdt_timeout_cfg *cfg)
{
        const struct wdt_driver_api *api =
                (const struct wdt_driver_api *) dev->api;
 
        return api->install_timeout(dev, cfg);
}
 
__syscall int wdt_feed(const struct device *dev, int channel_id);
 
static inline int z_impl_wdt_feed(const struct device *dev, int channel_id)
{
        const struct wdt_driver_api *api =
                (const struct wdt_driver_api *)dev->api;
 
        return api->feed(dev, channel_id);
}
 
#ifdef __cplusplus
}
#endif
 
#include <zephyr/syscalls/watchdog.h>
 
#endif /* ZEPHYR_INCLUDE_DRIVERS_WATCHDOG_H_ */