ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

HAL: Watchdog: Update the header file 

Add a SPDX license identifier.
Add defined & undefined behavior.
pull/10902/head
Filip Jagodzinski 2019-06-21 13:17:28 +02:00 committed by Martin Kojtal
parent 4e35e368b2
commit a33536e78e
1 changed files with 23 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
hal/watchdog_api.h
View File

@ -2,6 +2,7 @@
/** @{*/ /** @{*/
/* mbed Microcontroller Library /* mbed Microcontroller Library
* Copyright (c) 2017 ARM Limited * Copyright (c) 2017 ARM Limited
* SPDX-License-Identifier: Apache-2.0
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -26,10 +27,7 @@
/** /**
* \defgroup hal_watchdog Watchdog HAL API * \defgroup hal_watchdog Watchdog HAL API
* @{ * Low-level interface to the Independent Watchdog Timer of a target.
*/
/** \file watchdog_api.h
* *
* This module provides platform independent access to the system watchdog timer * 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 * which is an embedded peripheral that will reset the system in the case of
@ -38,12 +36,29 @@
* The watchdog timer initialises a system timer with a time period specified in * 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 * the configuration. This timer counts down and triggers a system reset when it
* wraps. To prevent the system reset the timer must be continually * wraps. To prevent the system reset the timer must be continually
* kicked/refreshed by calling hal_watchdog_kick which will reset the countdown * kicked/refreshed by calling ::hal_watchdog_kick which will reset the countdown
* to the user specified reset value. * to the user specified reset value.
* *
* The Watchdog timer must continue to operate in low power modes. It * # Defined behavior
* must count down and trigger a reset from within both sleep and deep sleep * * Sleep and debug modes don't stop the watchdog timer from counting down.
* modes unless the chip is woken to refresh the timer. * * The function ::hal_watchdog_init is safe to call repeatedly. The
* function's implementation must not do anything if ::hal_watchdog_init has
* already initialized the hardware watchdog timer.
* * Maximum supported timeout is `UINT32_MAX` milliseconds; minimum timeout
* is 1 millisecond.
* * The watchdog should trigger at or after the timeout value.
* * The watchdog should trigger before twice the timeout value.
*
* # Undefined behavior
* * Calling any function other than ::hal_watchdog_init or
* ::hal_watchdog_get_platform_features before you have initialized the watchdog.
*
* # Notes
* * A software reset may not stop the watchdog timer; the behavior is platform specific.
*
* @see hal_watchdog_tests
*
* @{
*/ */
typedef struct { typedef struct {