rtc.h
上传用户:yyyd609
上传日期:2022-07-18
资源大小:183k
文件大小:8k
源码类别:

微处理器开发

开发平台:

C/C++

  1. /******************** (C) COPYRIGHT 2003 STMicroelectronics ********************
  2. * File Name          : rtc.h
  3. * Author             : MCD Application Team
  4. * Date First Issued  : 20/05/2003
  5. * Description        : This file contains all the functions prototypes for the
  6. *                      RTC software library.
  7. ********************************************************************************
  8. * History:
  9. *  01/01/2004 : V1.2
  10. *  14/07/2004 : V1.3
  11. *******************************************************************************/
  12. #ifndef __RTC_H
  13. #define __RTC_H
  14. #include "71x_lib.h"
  15. typedef enum
  16. {
  17.   RTC_GIR  = 0x08,
  18.   RTC_OWIR = 0x04,
  19.   RTC_AIR  = 0x02,
  20.   RTC_SIR  = 0x01
  21. } RTC_FLAGS;
  22. typedef enum
  23. {
  24.   RTC_GIT  = 0x08,
  25.   RTC_OWIT = 0x04,
  26.   RTC_AIT  = 0x02,
  27.   RTC_SIT  = 0x01,
  28.   RTC_NONE = 0x00
  29. } RTC_IT;
  30. /*******************************************************************************
  31. * Function Name  : RTC_Delay
  32. * Description    : This routine is used to insert a delay
  33. * Input          : None
  34. * Return         : None
  35. *******************************************************************************/
  36. void RTC_Delay( void );
  37. /*******************************************************************************
  38. * Function Name  : RTC_ClearCounter
  39. * Description    : This routine is used to clear the RTC counter value
  40. * Input          : None
  41. * Return         : None
  42. *******************************************************************************/
  43. void RTC_ClearCounter (void);
  44. /*******************************************************************************
  45. * Function Name  : RTC_PrescalerValue
  46. * Description    : This routine is used to get the RTC prescaler Value
  47. * Input          : None
  48. * Return         : an u32 value that holds the prescaler Value.
  49. *******************************************************************************/
  50. inline u32 RTC_PrescalerValue (void)
  51. {
  52. return ( (u32)(RTC->PRLH & 0x000F) << 16 ) | RTC->PRLL;
  53. }
  54. /*******************************************************************************
  55. * Function Name  : RTC_PrescalerConfig
  56. * Description    : This routine is used to set the Prescaler Value
  57. * Input          : The New prescaler Value
  58. * Return         : None
  59. *******************************************************************************/
  60. void RTC_PrescalerConfig (u32 Xprescaler);
  61. /*******************************************************************************
  62. * Function Name  : RTC_CounterValue
  63. * Description    : This routine is used to get the RTC counter value
  64. * Input          : None
  65. * Return         : an u32 value that holds the current counter value.
  66. *******************************************************************************/
  67. inline u32 RTC_CounterValue (void)
  68. {
  69. return ( (u32)RTC->CNTH << 16 ) | RTC->CNTL;
  70. }
  71. /*******************************************************************************
  72. * Function Name  : RTC_AlarmValue
  73. * Description    : This routine is used to get the RTC alarm Value
  74. * Input          : None
  75. * Return         : an u32 value that holds the Real Time clock alarm time .
  76. *******************************************************************************/
  77. inline u32 RTC_AlarmValue (void)
  78. {
  79. return ( (u32)RTC->ALRH << 16 ) | RTC->ALRL;
  80. }
  81. /*******************************************************************************
  82. * Function Name  : RTC_AlarmConfig
  83. * Description    : This routine is used to set the RTC alarm Value
  84. * Input          : an u32 value that holds the Real Time clock alarm time .
  85. * Return         : None
  86. *******************************************************************************/
  87. void RTC_AlarmConfig (u32 Xalarm);
  88. /*******************************************************************************
  89. * Function Name  : RTC_GITconfig
  90. * Description    : This routine is used to configure Enable / Disable the Global
  91. *                : interrupt
  92. * Input          : The new status for the globale interrupt : Enable / Disable
  93. * Return         : None
  94. *******************************************************************************/
  95. void RTC_GITconfig (FunctionalState NewState );
  96. /*******************************************************************************
  97. * Function Name  : RTC_FlagStatus
  98. * Description    : This routine is used to chek the RTC flag status
  99. * Input          : an RTC flag
  100. * Return         : Set or RESET
  101. *******************************************************************************/
  102. inline FlagStatus RTC_FlagStatus (RTC_FLAGS Xflag)
  103. {
  104. return ( RTC->CRL & Xflag ) == 0 ? RESET : SET;
  105. }
  106. /*******************************************************************************
  107. * Function Name  : RTC_FlagClear
  108. * Description    : This routine is used to clear the RTC flags
  109. * Input          : an RTC flag
  110. * Return         : None
  111. *******************************************************************************/
  112. void RTC_FlagClear (RTC_FLAGS Xflag);
  113. /*******************************************************************************
  114. * Function Name  : RTC_ITConfig
  115. * Description    : This routine is used to configure the RTC interrupts
  116. * Input 1        : an RTC interrupt
  117. * Input 2        : Enable or Disable
  118. * Return         : None
  119. *******************************************************************************/
  120. inline void RTC_ITConfig (RTC_IT Xrtcit, FunctionalState NewState)
  121. {
  122.   if (NewState == ENABLE) RTC->CRH |= Xrtcit; else RTC->CRH &= ~Xrtcit;
  123. }
  124. /*******************************************************************************
  125. * Function Name  : RTC_ITStatus
  126. * Description    : This routine is used to get the RTC interrupts status
  127. * Input          : an RTC interrupt
  128. * Return         : Enable or Disable
  129. *******************************************************************************/
  130. inline FunctionalState RTC_ITStatus (RTC_IT Xrtcit)
  131. {
  132.   return ( RTC->CRH & Xrtcit ) == 0 ? DISABLE : ENABLE;
  133. }
  134. /*******************************************************************************
  135. * Function Name  : RTC_ITClear
  136. * Description    : This routine is used to clear the RTC interrupts
  137. * Input          : an RTC interrupt
  138. * Return         : None
  139. *******************************************************************************/
  140. void RTC_ITClear (RTC_IT Xrtcit);
  141. /*******************************************************************************
  142. * Function Name  : RTC_EnterCfgMode
  143. * Description    : This routine is used to enter in the Configuration Mode
  144. * Input          : None
  145. * Return         : None
  146. *******************************************************************************/
  147. void RTC_EnterCfgMode(void);
  148. /*******************************************************************************
  149. * Function Name  : RTC_ExitCfgMode
  150. * Description    : This routine is used to exit from the Configuration Mode
  151. * Input          : None
  152. * Return         : None
  153. *******************************************************************************/
  154. void RTC_ExitCfgMode(void);
  155. /*******************************************************************************
  156. * Function Name  : RTC_WaitForLastTask
  157. * Description    : This routine is waits for the last task completetion
  158. * Input          : None
  159. * Return         : None
  160. *******************************************************************************/
  161. void RTC_WaitForLastTask(void);
  162. /*******************************************************************************
  163. * Function Name  : RTC_SetTime
  164. * Description    : This routine sets the RTC Time
  165. * Input          : None
  166. * Return         : None
  167. *******************************************************************************/
  168. void RTC_SetTime(u8 TmpH, u8 TmpM, u8 TmpS );
  169. /*******************************************************************************
  170. * Function Name  : RTC_SetAlarmTime
  171. * Description    : This routine sets the Alarm Time
  172. * Input          : None
  173. * Return         : None
  174. *******************************************************************************/
  175. void RTC_SetAlarmTime(u8 TmpH, u8 TmpM, u8 TmpS );
  176. #endif // __RTC_H
  177. /******************* (C) COPYRIGHT 2003 STMicroelectronics *****END OF FILE****/