Kenji Arai / SetRTC

This is a RTC additional function. This is only for Nucleo F401RE & F411RE mbed(Added L152RE, F334R8, L476RG & F746xx). If you connected battery backup circuit for internal RTC, you can make a power-off and reset condition. RTC still has proper time and date.

Dependents:   Nucleo_rtos_sample PB_Emma_Ethernet

Please refer following NOTE information.
/users/kenjiArai/notebook/nucleo-series-rtc-control-under-power-onoff-and-re/

Diff: SetRTC.h

Revision:
1:3129de8d50ea
Parent:
0:e4c20fd769f1
--- a/SetRTC.h	Sat Feb 07 02:19:57 2015 +0000
+++ b/SetRTC.h	Sat Feb 14 11:31:51 2015 +0000
@@ -7,7 +7,7 @@
  *  http://www.page.sannet.ne.jp/kenjia/index.html
  *  http://mbed.org/users/kenjiArai/
  *      Created:  October   24th, 2014
- *      Revised:  Feburary   7th, 2015
+ *      Revised:  Feburary  14th, 2015
  *
  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
  * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE
@@ -16,6 +16,13 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
 
+/*
+ * CAUTION! You need to modify "rtc_api.c" file in the mbed-src library.
+ *          Please refer "modify_info_xxx.h" file and/or following NOTE.
+ *          http://developer.mbed.org/users/kenjiArai/notebook/
+ *              nucleo-series-rtc-control-under-power-onoff-and-re/
+ */
+
 #ifndef SET_RTC_H
 #define SET_RTC_H
 
@@ -37,6 +44,7 @@
  *      This is cased by mbed initial subroutine problem.
  *      This program intends to use RTC with X2 and works well with battery back-up hardware setting.
  *
+ *
  * @code
  * #include "mbed.h"
  * #include "SetRTC.h"
@@ -56,8 +64,22 @@
   */
 int32_t SetRTC(void);
 
+/** Show(print) RTC related registers
+  * @param none
+  * @return none
+  */
 void show_RTC_reg( void );
 
+/** Enter RTC initial data from PC Vertual Com
+  * @param none
+  * @return none
+  */
 void time_enter_mode(void);
 
+/** Preparation for Deep Sleep (Set I/O port and other peripheral low power condition)
+  * @param none
+  * @return none
+  */
+void deepsleep_preparation(void);
+
 #endif      // SET_RTC_H