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

Edit Watchdog.h 

Edit file to address comments and for consistent tense and voice.
pull/10954/head
Amanda Butler 2019-07-03 17:43:51 -05:00 committed by GitHub
parent 6f8266c02f
commit ec53d1d9c8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 25 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
drivers/Watchdog.h
View File

@ -30,18 +30,18 @@
namespace mbed { namespace mbed {
/** \addtogroup drivers */ /** \addtogroup drivers */
/** A hardware watchdog timer that will reset the system in the case of system /** A hardware watchdog timer that resets the system in the case of system
* failures or malfunctions. If you fail to refresh the Watchdog periodically, * failures or malfunctions. If you fail to refresh the Watchdog timer periodically,
* it will reset the system after a set period of time. * it resets the system after a set period of time.
* *
* There is only one instance in the system. Use Watchdog::get_instance to * There is only one instance of the Watchdog class in the system, which directly maps to the hardware.
* obtain a reference. * Use Watchdog::get_instance to obtain a reference.
* *
* Watchdog::start initializes a system timer with a time period specified in * Watchdog::start initializes a system timer with a time period specified in
* @a timeout param. This timer counts down and triggers a system reset * @a timeout param. This timer counts down and triggers a system reset
* when it wraps. To prevent the system reset, the timer must be continually * when it wraps. To prevent the system reset, you must periodically kick or refresh
* kicked/refreshed by calling Watchdog::kick, which will reset the countdown * the timer by calling Watchdog::kick, which resets the countdown
* to the user specified reset value. * to the initial value.
* *
* Example: * Example:
* @code * @code
@ -62,9 +62,6 @@ class Watchdog : private NonCopyable<Watchdog> {
public: public:
/** Get a reference to the single Watchdog instance in the system. /** Get a reference to the single Watchdog instance in the system.
*
* There is only one watchdog peripheral and only one Watchdog instance
* to control it.
* *
* @return A reference to the single Watchdog instance present in the system. * @return A reference to the single Watchdog instance present in the system.
*/ */
@ -82,11 +79,11 @@ public:
* *
* @note The timeout is set to a value returned by Watchdog::get_max_timeout. * @note The timeout is set to a value returned by Watchdog::get_max_timeout.
* *
* If the Watchdog is already running, this function does nothing. * If the Watchdog timer is already running, this function does nothing.
* *
* @return true, if the Watchdog timer was started successfully, * @return true if the Watchdog timer was started successfully;
* false, if Watchdog timer was not started or if the Watchdog * false if the Watchdog timer was not started or if the Watchdog
* is already running. * timer is already running.
*/ */
bool start(); bool start();
@ -97,20 +94,20 @@ public:
* *
* @param timeout Watchdog timeout in milliseconds. * @param timeout Watchdog timeout in milliseconds.
* *
* @return true, if the Watchdog timer was started successfully, * @return true if the Watchdog timer was started successfully;
* false, if Watchdog timer was not started or if the Watchdog * false if Watchdog timer was not started or if the Watchdog
* is already running. * timer is already running.
*/ */
bool start(uint32_t timeout); bool start(uint32_t timeout);
/** Stop the Watchdog timer. /** Stop the Watchdog timer.
* *
* Calling this function will attempt to disable a running Watchdog * Calling this function disables a running Watchdog
* peripheral if supported by the platform. * peripheral if the platform supports it.
* *
* @return true, if the Watchdog timer was successfully stopped, * @return true if the Watchdog timer was successfully stopped;
* false, if the Watchdog cannot be disabled on this platform * false if the Watchdog timer cannot be disabled on this platform
* or if the Watchdog has not been started. * or if the Watchdog timer has not been started.
*/ */
bool stop(); bool stop();
@ -129,19 +126,19 @@ public:
*/ */
uint32_t get_max_timeout() const; uint32_t get_max_timeout() const;
/** Check if the Watchdog is already running. /** Check if the Watchdog timer is already running.
* *
* @return true, if the Watchdog is running, * @return true if the Watchdog timer is running and
* false, otherwise. * false otherwise.
*/ */
bool is_running() const; bool is_running() const;
/** Refresh the Watchdog timer. /** Refresh the Watchdog timer.
* *
* Call this function periodically before the Watchdog times out. * Call this function periodically before the Watchdog times out.
* Otherwise, the system is reset. * Otherwise, the system resets.
* *
* If the Watchdog is not running, this function does nothing. * If the Watchdog timer is not running, this function does nothing.
*/ */
void kick(); void kick();