mirror of https://github.com/ARMmbed/mbed-os.git
150 lines
4.5 KiB
C
150 lines
4.5 KiB
C
/** \addtogroup hal */
|
|
/** @{*/
|
|
/* mbed Microcontroller Library
|
|
* Copyright (c) 2017 ARM Limited
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
#ifndef MBED_WATCHDOG_API_H
|
|
#define MBED_WATCHDOG_API_H
|
|
|
|
#if DEVICE_WATCHDOG
|
|
|
|
#include <stdbool.h>
|
|
#include <stdint.h>
|
|
|
|
/**
|
|
* \defgroup hal_watchdog Watchdog HAL API
|
|
* @{
|
|
*/
|
|
|
|
/** \file watchdog_api.h
|
|
*
|
|
* This module provides platform independent access to the system watchdog timer
|
|
* which is an embedded peripheral that will reset the system in the case of
|
|
* system failures or malfunctions.
|
|
*
|
|
* The watchdog timer initialises a system timer with a time period specified in
|
|
* the configuration. This timer counts down and triggers a system reset when it
|
|
* wraps. To prevent the system reset the timer must be continually
|
|
* kicked/refreshed by calling hal_watchdog_kick which will reset the countdown
|
|
* to the user specified reset value.
|
|
*
|
|
* The Watchdog timer must continue to operate in low power modes. It
|
|
* must count down and trigger a reset from within both sleep and deep sleep
|
|
* modes unless the chip is woken to refresh the timer.
|
|
*/
|
|
|
|
typedef struct {
|
|
/**
|
|
* Refresh value for the watchdog in milliseconds. The maximum value of this
|
|
* setting is platform dependent, to find the maximum value for the current
|
|
* platform call hal_watchdog_get_features() and check the timeout value
|
|
* member. The minimum valid value for this setting is 1, attempting to
|
|
* initialise the watchdog with a timeout of 0ms will return
|
|
* WATCHDOG_STATUS_INVALID_ARGUMENT.
|
|
*/
|
|
uint32_t timeout_ms;
|
|
} watchdog_config_t;
|
|
|
|
|
|
typedef struct {
|
|
/**
|
|
* Maximum timeout value for the watchdog in milliseconds.
|
|
*/
|
|
uint32_t max_timeout;
|
|
/**
|
|
* Watchdog configuration can be updated after the watchdog has been started
|
|
*/
|
|
bool update_config;
|
|
/**
|
|
* Watchdog can be stopped after it is started without a reset
|
|
*/
|
|
bool disable_watchdog;
|
|
} watchdog_features_t;
|
|
|
|
|
|
typedef enum {
|
|
WATCHDOG_STATUS_OK,
|
|
WATCHDOG_STATUS_NOT_SUPPORTED,
|
|
WATCHDOG_STATUS_INVALID_ARGUMENT
|
|
} watchdog_status_t;
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/** Initialise and start a watchdog timer with the given configuration.
|
|
*
|
|
* If the watchdog timer is configured and started successfully this
|
|
* function will return WATCHDOG_STATUS_OK.
|
|
*
|
|
* If the timeout specified is outside the range supported by the platform
|
|
* it will return WATCHDOG_STATUS_INVALID_ARGUMENT.
|
|
*
|
|
* @param[in] config Configuration settings for the watchdog timer
|
|
*
|
|
* @return WATCHDOG_STATUS_OK if the watchdog is configured correctly and
|
|
* has started. Otherwise a status indicating the fault.
|
|
*/
|
|
watchdog_status_t hal_watchdog_init(const watchdog_config_t *config);
|
|
|
|
/** Refreshes the watchdog timer.
|
|
*
|
|
* This function should be called periodically before the watchdog times out.
|
|
* Otherwise, the system is reset.
|
|
*
|
|
* If a watchdog is not currently running this function does nothing
|
|
*/
|
|
void hal_watchdog_kick(void);
|
|
|
|
/** Stops the watchdog timer
|
|
*
|
|
* Calling this function will attempt to disable any currently running watchdog
|
|
* timers if supported by the current platform
|
|
*
|
|
* @return Returns WATCHDOG_STATUS_OK if the watchdog timer was succesfully
|
|
* stopped, or if the timer was never started. Returns
|
|
* WATCHDOG_STATUS_NOT_SUPPORTED if the watchdog cannot be disabled on
|
|
* the current platform.
|
|
*/
|
|
watchdog_status_t hal_watchdog_stop(void);
|
|
|
|
/** Get the watchdog timer refresh value
|
|
*
|
|
* This function returns the configured refresh timeout of the watchdog timer.
|
|
*
|
|
* @return Reload value for the watchdog timer in milliseconds.
|
|
*/
|
|
uint32_t hal_watchdog_get_reload_value(void);
|
|
|
|
/** Get information on the current platforms supported watchdog functionality
|
|
*
|
|
* @return watchdog_feature_t indicating supported watchdog features on the
|
|
* current platform
|
|
*/
|
|
watchdog_features_t hal_watchdog_get_platform_features(void);
|
|
|
|
/**@}*/
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif // DEVICE_WATCHDOG
|
|
|
|
#endif // MBED_WATCHDOG_API_H
|
|
|
|
/** @}*/
|