aboutsummaryrefslogtreecommitdiffstats
path: root/os/various/chrtclib.c
diff options
context:
space:
mode:
authorgdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2012-06-14 16:45:57 +0000
committergdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2012-06-14 16:45:57 +0000
commit2b1173e29246cbc82f45490d0b1b1443d7bf897a (patch)
tree43a43b5de70a4463ae050560f6ebde75f502b0b7 /os/various/chrtclib.c
parent18cab5548c02bd6c52af77be2a737a8a8fd47070 (diff)
downloadChibiOS-2b1173e29246cbc82f45490d0b1b1443d7bf897a.tar.gz
ChibiOS-2b1173e29246cbc82f45490d0b1b1443d7bf897a.tar.bz2
ChibiOS-2b1173e29246cbc82f45490d0b1b1443d7bf897a.zip
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@4276 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'os/various/chrtclib.c')
-rw-r--r--os/various/chrtclib.c14
1 files changed, 13 insertions, 1 deletions
diff --git a/os/various/chrtclib.c b/os/various/chrtclib.c
index f76f91d65..1a0a5487d 100644
--- a/os/various/chrtclib.c
+++ b/os/various/chrtclib.c
@@ -22,6 +22,14 @@
aka barthess.
*/
+/**
+ * @file chrtclib.c
+ * @brief RTC time conversion utilities code.
+ *
+ * @addtogroup chrtclib
+ * @{
+ */
+
#include <time.h>
#include "ch.h"
@@ -31,7 +39,7 @@
#if (defined(STM32F4XX) || defined(STM32F2XX) || defined(STM32L1XX) || \
defined(STM32F1XX) || defined(STM32F10X_MD) || defined(STM32F10X_LD) || \
- defined(STM32F10X_HD))
+ defined(STM32F10X_HD) || defined(__DOXYGEN__))
#if STM32_RTC_IS_CALENDAR
/**
* @brief Converts from STM32 BCD to canonicalized time format.
@@ -194,6 +202,7 @@ time_t rtcGetTimeUnixSec(RTCDriver *rtcp) {
* @brief Sets RTC time.
*
* @param[in] rtcp pointer to RTC driver structure
+ * @param[in] tv_sec time specification
* @return Unix time value in seconds.
*
* @api
@@ -285,6 +294,7 @@ time_t rtcGetTimeUnixSec(RTCDriver *rtcp) {
* @brief Sets RTC time.
*
* @param[in] rtcp pointer to RTC driver structure
+ * @param[in] tv_sec time specification
* @return Unix time value in seconds.
*
* @api
@@ -342,3 +352,5 @@ uint32_t rtcGetTimeFat(RTCDriver *rtcp) {
fattime |= (timp->tm_year - 80) << 25;
return fattime;
}
+
+/** @} */