add documentation

Author: Tharazi97

TESTS/mbed_drivers/watchdog_reset/Watchdog_reset_tests.h

@@ -64,6 +64,16 @@ void test_restart_reset();
  */
 void test_kick_reset();
 
+/** Test Watchdog timeout
+ *
+ * Given a device with a Watchdog started,
+ * when the Watchdog timout doesn't expire,
+ * then the device restart is not performed.
+ * When the Watchdog timout do expires,
+ * then the device is restarted after the timeout and before twice the timeout value.
+ */
+void test_timeout();
+
 #endif
 
 #endif

TESTS/mbed_drivers/watchdog_reset/main.cpp

@@ -282,8 +282,11 @@ void test_timeout()
     }
 
     // Phase 1. -- run the test code.
-    // Kick watchdog before timeout.
     TEST_ASSERT_TRUE(watchdog.start(TIMEOUT_LOWER_LIMIT));
+    
+    // Kick watchdog before timeout.
+    // Watchdog should not trigger before timeout.
+    // If device restarts while waiting for the kick, test fails.
     wait_ms(TIMEOUT_LOWER_LIMIT - window);
     watchdog.kick();
 
@@ -293,6 +296,7 @@ void test_timeout()
     }
     watchdog.kick();
 
+    // Watchdog should fire before twice the timeout value.
     wait_ms(2 * TIMEOUT_LOWER_LIMIT);
 
     // Watchdog reset should have occurred during that wait() above;

TESTS/mbed_hal/watchdog_reset/main.cpp

@@ -268,10 +268,12 @@ void test_timeout()
     }
 
     // Phase 1. -- run the test code.
-    // Kick watchdog before timeout.
     watchdog_config_t config = { TIMEOUT_LOWER_LIMIT };
-
     TEST_ASSERT_EQUAL(WATCHDOG_STATUS_OK, hal_watchdog_init(&config));
+
+    // Kick watchdog before timeout.
+    // Watchdog should not trigger before timeout.
+    // If device restarts while waiting for the kick, test fails.
     wait_ms(TIMEOUT_LOWER_LIMIT - window);
     hal_watchdog_kick();
 
@@ -281,6 +283,7 @@ void test_timeout()
     }
     hal_watchdog_kick();
 
+    // Watchdog should fire before twice the timeout value.
     wait_ms(2 * TIMEOUT_LOWER_LIMIT);
 
     // Watchdog reset should have occurred during that wait() above;

TESTS/mbed_hal/watchdog_reset/watchdog_reset_tests.h

@@ -69,6 +69,16 @@ void test_restart_reset();
  */
 void test_kick_reset();
 
+/** Test Watchdog timeout
+ *
+ * Given a device with a Watchdog started,
+ * when the Watchdog timout doesn't expire,
+ * then the device restart is not performed.
+ * When the Watchdog timout do expires,
+ * then the device is restarted after the timeout and before twice the timeout value.
+ */
+void test_timeout();
+
 #endif
 
 #endif