aboutsummaryrefslogtreecommitdiffstats
path: root/os/hal/include/rtc.h
blob: 4a36f43170ac08becd56a5e476b2217523218607 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
/**
 * @file    rtc.h
 * @brief   RTC Driver macros and structures.
 *
 * @addtogroup RTC
 * @{
 */


#ifndef _RTC_H_
#define _RTC_H_



#if HAL_USE_RTC || defined(__DOXYGEN__)

/*===========================================================================*/
/* Driver constants.                                                         */
/*===========================================================================*/
/* TODO: move this to hal_lld_f103.h & mcuconf.h */
#define STM32_LSECLK             32768       /**< Low speed external clock.  */


/* RCC_CFGR register bits definitions.*/
#define STM32_RTC_NONE           (0 << 8)    /**< */
#define STM32_RTC_LSE            (1 << 8)    /**< LSE oscillator clock used as RTC clock */
#define STM32_RTC_LSI            (2 << 8)    /**< LSI oscillator clock used as RTC clock */
#define STM32_RTC_HSE            (3 << 8)    /**< HSE oscillator clock divided by 128 used as RTC clock */


/*===========================================================================*/
/* Driver pre-compile time settings.                                         */
/*===========================================================================*/

/*===========================================================================*/
/* Derived constants and error checks.                                       */
/*===========================================================================*/

/*===========================================================================*/
/* Driver data structures and types.                                         */
/*===========================================================================*/

typedef struct RTCDriver RTCDriver;

typedef void (*rtccb_t)(RTCDriver *rtcp);

#include "rtc_lld.h"

/*===========================================================================*/
/* Driver macros.                                                            */
/*===========================================================================*/

/*===========================================================================*/
/* External declarations.                                                    */
/*===========================================================================*/

#ifdef __cplusplus
extern "C" {
#endif
  void rtcInit(void);
#if RTC_SUPPORTS_CALLBACKS
  void rtcStart(RTCDriver *rtcp, RTCConfig *rtccfgp);
  void rtcStop(void);
#endif /* RTC_SUPPORTS_CALLBACKS */
  void rtcSetTime(uint32_t tv_sec);
  uint32_t rtcGetSec(void);
  uint16_t rtcGetMsec(void);
  void rtcSetAlarm(uint32_t tv_alarm);
  uint32_t rtcGetAlarm(void);
#ifdef __cplusplus
}
#endif

#endif /* HAL_USE_RTC */
#endif /* _RTC_H_ */

/** @} */