第二十二章 RTC实时时钟实验

       本章，我们将介绍STM32G474的内部实时时钟（RTC）。我们将使用LCD模块来显示日期和时间，实现一个简单的实时时钟，并可以设置闹铃，另外还将介绍BKP的使用。

       本章分为如下几个小节：

       22.1 RTC时钟简介

       22.2 硬件设计

       22.3 程序设计

       22.4 下载验证

        22.1 RTC时钟简介

       STM32G474的实时时钟（RTC）是一个独立的定时器。STM32的RTC模块拥有一组连续计数的计数器，在相对应的软件配置下，可提供时钟日历的功能。修改计数器的值可以重新设置系统的当前时间和日期。

       RTC模块和时钟配置是在后备区域，即在系统复位或从待机模式唤醒后RTC的设置和时间维持不变，只要后备区域供电正常，那么RTC将可以一直运行。但是在系统复位后，会自动禁止访问后备寄存器和RTC，以防止对后备区域(BKP)的意外写操作。所以在要设置时间之前，先要取消备份区域（BKP）写保护。

       22.1.1 RTC框图

       下面先来学习RTC框图，通过学习RTC框图会有一个很好的整体掌握，同时对之后的编程也会有一个清晰的思路。RTC的框图，如图22.1.1所示：

图22.1.1 RTC框图

       我们把RTC框图分成以下几个部分讲解：

       ① 时钟源

       STM32的RTC时钟源rtc_ker_ck（RTCCLK）通过时钟控制器，可以从LSE时钟、LSI时钟以及HSE时钟三者中选择其一（通过设置RCC_BDCR寄存器选择）。一般我们选择LSE，即外部32.768KHz晶振作为时钟源(RTCCLK)。外部晶振具有精度高的优点。LSI是STM32芯片内部的低速RC 振荡器，频率约32 KHz，缺点是精度较低，所以一般不建议使用。比如当没有外部低速晶振（32.768KHz）的时候，分频后的HSE可以作为备选使用的时钟源。

       ② 预分频器

       预分配器（RTC_PRER）分为2个部分：一个通过RTC_PRER寄存器的PREDIV_A位配置的7位异步预分频器。另一个通过RTC_PRER寄存器的PREDIV_S位配置的15位同步预分频器。

       经过7位异步预分频器出来的时钟ck_apre可作为RTC_SSR亚秒递减计数器（RTC_SSR）的时钟，ck_apre时钟频率的计算公式如下：

       当RTC_SSR寄存器递减到0的时候，会使用PREDIV_S的值重新装载PREDIV_S。而PREDIV_S一般为255，这样，我们得到亚秒时间的精度是：1/256秒，即3.9ms左右，有了这个亚秒寄存器RTC_SSR，就可以得到更加精确的时间数据。

       经过15位同步预分频器出来的时钟ck_spre可以用于更新日历，也可以用作16位唤醒自动重载定时器的时基，ck_apre时钟频率的计算公式如下：

       PREDIV_A和PREDIV_S分别为RTC的异步和同步分频器，使用两个预分频器时，我们推荐设置7位异步预分频器（PREDIV_A）的值较大，以最大程度降低功耗。例如：本实验我们的外部低速晶振的频率32.768KHz经过7位异步预分频器后，再经过15位同步预分频器，要得到1Hz频率的时钟用于更新日历。通过计算知道，32.768KHz的时钟要经过32768分频，才能得到1Hz的ck_spre。于是我们只需要设置：PREDIV_A=0X7F，即128分频；PREDIV_S=0XFF，即256分频，即可得到1Hz的Fck_spre，PREDIV_A的值我们也是往尽量大的原则，以最大程度降低功耗。

       ③ 时间和日期相关寄存器

       该部分包括三个影子寄存器，RTC_SSR（亚秒）、RTC_TR（时间）、RTC_DR（日期）。实时时钟一般表示为：时/分/秒/亚秒。RTC_TR寄存器用于存储时/分/秒时间数据，可读可写（即可设置或者获取时间）。RTC_DR寄存器用于存储日期数据，包括年/月/日/星期，可读可写（即可设置或者获取日期）。RTC_SSR寄存器用于存储亚秒级的时间，这样我们可以获取更加精确的时间数据。

       这三个影子寄存器可以通过与PCLK（APB时钟）同步的影子寄存器来访问，这些时间和日期寄存器也可以直接访问，这样可避免等待同步的持续时间。

       每隔2个RTCCLK周期，当前日历值便会复制到影子寄存器，并置位RTC_ISR寄存器的RSF位。我们可以读取RTC_TR和RTC_DR来得到当前时间和日期信息，不过需要注意的是：时间和日期都是以BCD码的格式存储的，读出来要转换一下，才可以得到十进制的数据。

       ④ 可编程闹钟

       STM32G474提供两个可编程闹钟：闹钟A（ALARM_A）和闹钟B（ALARM_B）。通过RTC_CR寄存器的ALRAE和ALRBE位置1来使能闹钟。当亚秒、秒、分、小时、日期分别与闹钟寄存器RTC_ALRMASSR/RTC_ALRMAR和RTC_ALRMBSSR/RTC_ALRMBR中的值匹配时，则可以产生闹钟（需要适当配置）。本章我们将利用闹钟A产生闹铃，即设置RTC_ALRMASSR和RTC_ALRMAR即可。

       ⑤ 周期性自动唤醒

       STM32G474的RTC不带秒钟中断了，但是多了一个周期性自动唤醒功能。周期性唤醒功能，由一个16位可编程自动重载递减计数器（RTC_WUTR）生成，可用于周期性中断/唤醒。

       我们可以通过RTC_CR寄存器中的WUTE位设置使能此唤醒功能。

       唤醒定时器的时钟输入可以是：2、4、8或16分频的RTC时钟(RTCCLK)，也可以是ck_spre时钟（一般为1Hz）。

       当选择RTCCLK(假定LSE是：32.768 KHz)作为输入时钟时，可配置的唤醒中断周期介于 122us（因为RTCCLK/2时，RTC_WUTR不能设置为0）和32 s之间，分辨率最低为：61us。

       当选择ck_spre（1Hz）作为输入时钟时，可得到的唤醒时间为 1s到36h左右，分辨率为1 秒。并且这个1s~36h的可编程时间范围分为两部分：

       当WUCKSEL[2:1]=10时为：1s到18h。

       当WUCKSEL[2:1]=11时约为：18h到36h。

       在后一种情况下，会将2^16添加到16位计数器当前值（即扩展到17位，相当于最高位用WUCKSEL [1]代替）。

       初始化完成后，定时器开始递减计数。在低功耗模式下使能唤醒功能时，递减计数保持有效。此外，当计数器计数到0时，RTC_ISR寄存器的WUTF标志会置1，并且唤醒寄存器会使用其重载值（RTC_WUTR寄存器值）自动重载，之后必须用软件清零WUTF标志。

       通过将 RTC_CR寄存器中的WUTIE位置1来使能周期性唤醒中断时，可以使STM32退出低功耗模式。系统复位以及低功耗模式（睡眠、停机和待机）对唤醒定时器没有任何影响，它仍然可以正常工作，故唤醒定时器，可以用于周期性唤醒STM32。

       22.1.2 RTC寄存器

       接下来，我们介绍本实验我们要用到的RTC寄存器。

       l RTC时间寄存器（RTC_TR）

       RTC时间寄存器描述如图22.1.2.1所示：

图22.1.2.1 RTC_TR寄存器

       该寄存器是RTC的时间寄存器，可读可写，对该寄存器写，可以设置时间，对该寄存器读，可以获取当前的时间，此外该寄存器受到寄存器写保护，通过RTC写保护寄存器(RTC_WPR)设置，后面会讲解到RTC_WPR寄存器。需要注意的是：本寄存器存储的数据都是BCD格式的，读取之后需要进行转换，方可得到十进制的时分秒等数据。

       l RTC日期寄存器（RTC_DR）

       RTC日期寄存器描述如图22.1.2.2所示：

图22.1.2.2 RTC_DR寄存器

       该寄存器是RTC的日期寄存器，可读可写，对该寄存器写，可以设置日期，对该寄存器读，可以获取当前的日期，同样该寄存器也受到寄存器写保护，存储的数据也都是BCD格式的。

       l RTC控制寄存器（RTC_CR）

       RTC控制寄存器描述如图22.1.2.3所示：

图22.1.2.3 RTC_CR寄存器

       该寄存器重点介绍几个要用到的位：WUTIE是唤醒定时器中断使能位，ALRAIE是闹钟A中断使能位，本章用到这两个使能位，都设置为1即可。WUTE和ALRAE分别是唤醒定时器和闹钟A使能位，同样都设置为1，开启。FMT为小时格式选择位，我们设置为0，选择24小时制。WUCKSEL[2:0]，用于唤醒时钟选择，这个前面已经有介绍了，我们这里就不多说了。

       l RTC亚秒寄存器（RTC_SSR）

       RTC亚秒寄存器描述如图22.1.2.4所示：

图22.1.2.4 RTC_SSR寄存器

       该寄存器可用于获取更加精确的RTC时间。不过，在本章没有用到，如果需要精确时间的地方，大家可以使用该寄存器。

       l RTC初始化和状态寄存器（RTC_ICSR）

       RTC初始化和状态寄存器描述如图22.1.2.5所示：

图22.1.2.5 RTC_ICSR寄存器

       INIT为初始化模式控制位，要初始化RTC时，必须先设置INIT=1。

       INITF为初始化标志位，当设置INIT为1以后，要等待INITF为1，才可以更新时间、日期和预分频寄存器等。

       RSF位为寄存器同步标志，仅在该位为1时，表示日历影子寄存器已同步，可以正确读取RTC_TR/RTC_TR寄存器的值了。

       WUTWF、ALRBWF和ALRAWF分别是唤醒定时器、闹钟B和闹钟A的写标志，只有在这些位为1的时候，才可以更新对应的内容。比如：要设置闹钟A的ALRMAR和ALRMASSR，则必须先等待ALRAWF为1，才可以设置。

       l RTC预分频寄存器（RTC_PRER）

       RTC预分频寄存器描述如图22.1.2.6所示：

图22.1.2.6 RTC_PRER寄存器

       该寄存器用于RTC的分频，我们在之前也有讲过，这里就不多说了。该寄存器的配置，必须在初始化模式（INITF=1）下，才可以进行。

       l RTC唤醒寄存器（RTC_WUTR）

       RTC唤醒寄存器描述如图22.1.2.7所示：

图22.1.2.7 RTC_WUTR寄存器

       该寄存器用于设置自动唤醒重装载值，可用于设置唤醒周期。该寄存器的配置，必须等待RTC_ISR的WUTWF为1才可以进行。

       l RTC闹钟A寄存器（RTC_ALRMAR）

       RTC闹钟A寄存器描述如图22.1.2.8所示：

图22.1.2.8 RTC_ALRMAR寄存器

       该寄存器用于设置闹铃A，当WDSEL选择1时，使用星期制闹铃，本章我们选择星期制闹铃。该寄存器的配置，必须等待RTC_ISR的ALRAWF为1才可以进行。另外，还有RTC_ALRMASSR寄存器，该寄存器我们这里就不再介绍了，大家参考手册。

       l RTC写保护寄存器（RTC_WPR）

       RTC写保护寄存器：RTC_WPR，该寄存器比较简单，低八位有效。上电后，所有RTC寄存器都受到写保护（RTC_ISR[13:8]、RTC_TAFCR和RTC_BKPxR除外），必须依次写入：0xCA、0x53两关键字到RTC_WPR寄存器，才可以解锁。写一个错误的关键字将再次激活RTC的寄存器写保护。

 

        22.2 硬件设计

       1. 例程功能

       本实验通过LCD显示RTC时间，并可以通过usmart设置RTC时间，从而调节时间，或设置RTC闹钟，还可以写入或者读取RTC后备区域SRAM。LED1每两秒闪烁一次，表示进入WAKE UP中断。LED0闪烁，提示程序运行。

       2. 硬件资源

       1）LED灯

              LED0 – PE0

              LED1 – PE1

       2）串口1(PB6/PB7连接在板载USB转串口芯片CH340上面)

       3）RTC(实时时钟)

       4）正点原子1.3寸TFTLCD模块(SPI接口)

       3. 原理图

       RTC属于STM32G474内部资源，通过软件设置好就可以了。不过RTC不能断电，否则数据就丢失了，我们如果想让时间在断电后还可以继续走，那么必须确保开发板的电池有电。

        22.3 程序设计 

       22.3.1 RTC的HAL库驱动

       RTC在HAL库中的驱动代码在stm3g4xx_hal_rtc.c文件（及其头文件）中。下面介绍几个重要的RTC函数，其他没有介绍的请看源码。

        1. HAL_RTC_Init函数

       RTC的初始化函数，其声明如下：

HAL_StatusTypeDef HAL_RTC_Init(RTC_HandleTypeDef *hrtc);

       l 函数描述：

       用于初始化RTC。

       l 函数形参：

       形参1是RTC_HandleTypeDef结构体类型指针变量，其定义如下：

typedef struct
{
  RTC_TypeDef                    *Instance;  /* 寄存器基地址 */
  RTC_InitTypeDef               Init;        /* RTC配置结构体 */
  HAL_LockTypeDef               Lock;        /* RTC锁定对象 */
  __IO HAL_RTCStateTypeDef    State;       /* RTC设备访问状态 */
}RTC_HandleTypeDef;

       1）Instance：指向RTC寄存器基地址。

       2）Init：是真正的RTC初始化结构体，其结构体类型RTC_InitTypeDef定义如下：

typedef struct
{
  uint32_t HourFormat;        /* 小时格式 */
  uint32_t AsynchPrediv;      /* 异步预分频系数 */
  uint32_t SynchPrediv;       /* 同步预分频系数 */  
  uint32_t OutPut;             /* 选择连接到RTC_ALARM输出的标志 */   
  uint32_t OutPutRemap;          /* RTC输出映射 */   
  uint32_t OutPutPolarity;   /* 设置RTC_ALARM的输出极性 */
  uint32_t OutPutType;        /* 设置RTC_ALARM的输出类型为开漏输出还是推挽输出 */
  uint32_t OutPutPullUp;        /* 设置RTC输出上拉模式 */  
}RTC_InitTypeDef;

       HourFormat用来设置小时格式，可以是12小时制或者24小时制，这两个选项的宏定义分别为RTC_HOURFORMAT_12和RTC_HOURFORMAT_24。

       AsynchPrediv用来设置RTC的异步预分频系数，也就是设置RTC_PRER寄存器的PREDIV_A相关位，因为异步预分频系数是7位，所以最大值为0x7F，不能超过这个值。

       SynchPrediv用来设置RTC的同步预分频系数，也就是设置RTC_PRER寄存器的PREDIV_S相关位，因为同步预分频系数也是15位，所以最大值为0x7FFF，不能超过这个值。

       OutPut用来选择要连接到RTC_ALARM输出的标志，取值为：RTC_OUTPUT_DISABLE（禁止输出），RTC_OUTPUT_ALARMA（使能闹钟A输出），RTC_OUTPUT_ALARMB（使能闹钟B输出）和RTC_OUTPUT_WAKEUP（使能唤醒输出）。

       OutPutPolarity用来设置RTC_ALARM的输出极性，与Output成员变量配合使用，取值为RTC_OUTPUT_POLARITY_HIGH（高电平）或RTC_OUTPUT_POLARITY_LOW（低电平）。

       OutPutType用来设置RTC_ALARM的输出类型为开漏输出（RTC_OUTPUT_TYPE_ OPENDRAIN）还是推挽输出（RTC_OUTPUT_TYPE_PUSHPULL），与成员变量OutPut和OutPutPolarity配合使用。

       3）Lock：用于配置锁状态。

       4）State：RTC设备访问状态。

       l 函数返回值：

       HAL_StatusTypeDef枚举类型的值。

        2. HAL_RTC_SetTime函数

       HAL_RTC_SetTime是设置RTC的时间函数。其声明如下：

HAL_StatusTypeDef HAL_RTC_SetTime(RTC_HandleTypeDef *hrtc,
RTC_TimeTypeDef *sTime, uint32_t Format);

       l 函数描述：

       该函数用于设置RTC的时间，即设置时间寄存器RTC_TR的相关位的值。

       l 函数形参：

       形参1是RTC_HandleTypeDef结构体类型指针变量，即RTC的句柄。

       形参2是RTC_TimeTypeDef结构体类型指针变量，定义如下：

typedef struct
{
  uint8_t Hours;
  uint8_t Minutes;
  uint8_t Seconds;
  uint8_t TimeFormat;
  uint32_t SubSeconds;
  uint32_t SecondFraction;
  uint32_t DayLightSaving;
  uint32_t StoreOperation; 
}RTC_TimeTypeDef;

       前面四个成员变量就比较好理解了，分别用来设置RTC时间参数的小时，分钟，秒钟，以及AM/PM符号，大家参考前面讲解的RTC_TR的位描述即可。SubSeconds用来读取保存亚秒寄存器 RTC_SSR的值，SecondFraction用来读取保存同步预分频系数的值，也就是RTC_PRER的位0~14，DayLightSaving用来设置日历时间增加1小时，减少1小时，还是不变。StoreOperation用户可对此变量设置以记录是否已对夏令时进行更改。

       形参3是uint32_t类型变量，用来设置时间格式为BIN格式还是BCD格式，可选值为RTC_FORMAT_BIN或者RTC_FORMAT_BCD。

       l 函数返回值：

       HAL_StatusTypeDef枚举类型的值。

        3. HAL_RTC_SetDate函数

       HAL_RTC_SetDate是设置RTC的日期函数。其声明如下：

HAL_StatusTypeDef HAL_RTC_SetDate(RTC_HandleTypeDef *hrtc,
RTC_DateTypeDef *sDate, uint32_t Format);

       l 函数描述：

       该函数用于设置RTC的日期，即设置日期寄存器RTC_DR的相关位的值。

       l 函数形参：

       形参1是RTC_HandleTypeDef结构体类型指针变量，即RTC的句柄。

       形参2是RTC_DateTypeDef结构体类型指针变量，定义如下：

typedef struct
{
  uint8_t WeekDay;   /* 星期 */
  uint8_t Month;     /* 月份 */
  uint8_t Date;      /* 日期 */
  uint8_t Year;      /* 年份 */
}RTC_DateTypeDef;

       结构体一共四个成员变量，这四个成员变量分别对应星期、月份、日期和年份，对应的是RTC_DR寄存器。

       形参3是uint32_t类型变量，用来设置时间格式为BIN格式还是BCD格式，可选值为RTC_FORMAT_BIN或者RTC_FORMAT_BCD。

       l 函数返回值：

       HAL_StatusTypeDef枚举类型的值。

        4. HAL_RTC_GetTime函数

       HAL_RTC_GetTime是获取当前RTC时间函数。其声明如下：

HAL_StatusTypeDef HAL_RTC_GetTime(RTC_HandleTypeDef *hrtc,
RTC_TimeTypeDef *sTime, uint32_t Format);

       l 函数描述：

       该函数用于获取当前RTC时间，即读时间寄存器RTC_TR的相关位的值。

       l 函数形参：

       形参1是RTC_HandleTypeDef结构体类型指针变量，即RTC的句柄。

       形参2是RTC_TimeTypeDef结构体类型指针变量，对应的是RTC_TR寄存器。

       形参3是uint32_t类型变量，用来设置时间格式为BIN格式还是BCD格式，可选值为RTC_FORMAT_BIN或者RTC_FORMAT_BCD。

       l 函数返回值：

       HAL_StatusTypeDef枚举类型的值。

        5. HAL_RTC_GetDate函数

       HAL_RTC_GetDate是获取当前RTC日期函数。其声明如下：

HAL_StatusTypeDef HAL_RTC_SetDate (RTC_HandleTypeDef *hrtc,
RTC_DateTypeDef *sDate, uint32_t Format);

       l 函数描述：

       该函数用于获取当前RTC日期，即读时间寄存器RTC_DR的相关位的值。

       l 函数形参：

       形参1是RTC_HandleTypeDef结构体类型指针变量，即RTC的句柄。

       形参2是RTC_DateTypeDef结构体类型指针变量，对应的是RTC_DR寄存器。

       形参3是uint32_t类型变量，用来设置日期格式为BIN格式还是BCD格式，可选值为RTC_FORMAT_BIN或者RTC_FORMAT_BCD。

       l 函数返回值：

       HAL_StatusTypeDef枚举类型的值。

        6. HAL_RTC_SetAlarm_IT函数

       HAL_RTC_SetAlarm_IT是设置闹钟并开启闹钟中断的函数。其声明如下：

HAL_StatusTypeDef HAL_RTC_SetAlarm_IT(RTC_HandleTypeDef *hrtc,
RTC_AlarmTypeDef *sAlarm, uint32_t Format);

       l 函数描述：

       该函数用于设置闹钟并开启闹钟中断。

       l 函数形参：

       形参1是RTC_HandleTypeDef结构体类型指针变量，即RTC的句柄。

       形参2是RTC_AlarmTypeDef结构体类型指针变量。

       形参3是uint32_t类型变量，用来设置时间格式为BIN格式还是BCD格式，可选值为RTC_FORMAT_BIN或者RTC_FORMAT_BCD。

       重点介绍RTC_AlarmTypeDef结构体指针类型，结构体定义如下：

typedef struct
{
  RTC_TimeTypeDef AlarmTime;
  uint32_t AlarmMask;
  uint32_t AlarmSubSecondMask;
  uint32_t AlarmDateWeekDaySel;
  uint8_t AlarmDateWeekDay;
  uint32_t Alarm;
}RTC_AlarmTypeDef;

       AlarmTime用来设置闹钟时间，是RTC_TimeTypeDef结构体类型，该结构体前面我们已经讲解过各个成员变量含义。

       AlarmMask用来设置闹钟时间掩码，也就是在我们第一个参数设置的时间中（包括后面参数RTC_AlarmDateWeekDay设置的星期几/哪一天），哪些是无关的。比如我们设置闹钟时间为每天的10点10分10秒，那么我们可以选择值RTC_AlarmMask_DateWeekDay，也就是我们不关心是星期几/每月哪一天。这里我们选择为RTC_AlarmMask_None，也就是精确匹配时间，所有的时分秒以及星期几/(或者每月哪一天)都要精确匹配。

       AlarmSubSecondMask和AlarmMask作用类似，只不过该变量是用来设置亚秒的。

       AlarmDateWeekDaySel用来选择是闹钟是按日期还是按星期。比如我们选择RTC_AlarmDateWeekDaySel_WeekDay那么闹钟就是按星期。如果我们选择RTC_AlarmDateWeekDaySel_Date那么闹钟就是按日期。这与后面第四个参数是有关联的，我们在后面第四个参数讲解。

       AlarmDateWeekDay用来设置闹钟的日期或者星期几。比如我们第三个参数RTC_AlarmDateWeekDaySel设置了值为RTC_AlarmDateWeekDaySel_WeekDay，也就是按星期，那么参数RTC_AlarmDateWeekDay的取值范围就为星期一到星期天，也就是RTC_Weekday_Monday到RTC_Weekday_Sunday。如果第三个参数RTC_AlarmDateWeekDaySel设置值为RTC_AlarmDateWeekDaySel_Date，那么它的取值范围就为日期值，0~31。

       Alarm用来设置是闹钟A还是闹钟B，这个很好理解。

       l 函数返回值：

       HAL_StatusTypeDef枚举类型的值。

       RTC配置步骤

       1）使能电源时钟，并使能RTC及RTC后备寄存器写访问

       我们要访问RTC和RTC备份区域就必须先使能电源时钟，然后使能RTC即后备区域访问。电源时钟使能，通过RCC_APB1ENR寄存器来设置；RTC及RTC备份寄存器的写访问，通过PWR_CR寄存器的DBP位设置。HAL库设置方法为：

__HAL_RCC_PWR_CLK_ENABLE();  /* 使能电源时钟PWR */
__HAL_RCC_RTC_ENABLE();     /* 使能RTC时钟 */
HAL_PWR_EnableBkUpAccess();  /* 取消备份区域写保护 */

       2）开启外部低速振荡器LSE，选择RTC时钟，并使能

       调用HAL_RCC_OscConfig函数配置开启LSE。

       调用HAL_RCCEx_PeriphCLKConfig函数选择RTC时钟源。

       使能RTC函数为：__HAL_RCC_RTC_ENABLE。

       3）初始化RTC，设置RTC的分频，以及配置RTC参数

       在HAL中，通过HAL_RTC_Init函数配置RTC分频系数，以及RTC的工作参数。

       注意：该函数会调用HAL_RTC_MspInit函数来完成对RTC的底层初始化，包括：RTC时钟使能、时钟源选择等。

       4）设置RTC的时间

       调用HAL_RTC_SetTime函数设置RTC时间，该函数实际设置时间寄存器RTC_TR的相关位的值。

       5）设置RTC的日期

       调用HAL_RTC_SetDate函数设置RTC的日期，该函数实际设置日期寄存器RTC_DR的相关位的值。

       6）获取RTC当前日期和时间

       调用HAL_RTC_GetTime函数获取当前RTC时间，该函数实际读取RTC_TR寄存器，然后将值存放到相应的结构体中。

       调用HAL_RTC_GetDate函数获取当前RTC日期，该函数实际读取RTC_DR寄存器，然后将值存放到相应的结构体中。

       通过以上6个步骤，我们就完成了对RTC的配置，RTC即可正常工作，而且这些操作不是每次上电都必须执行的，可以视情况而定。当然，我们还可以唤醒中断、闹钟等，这些将在后面介绍。

       22.3.2 程序流程图

图22.3.2.1 RTC实时时钟实验程序流程图

       22.3.3 程序解析

       1. RTC驱动代码

       这里我们只讲解核心代码，详细的源码请大家参考光盘本实验对应源码。RTC驱动源码包括两个文件：rtc.c和rtc.h。

       由于篇幅所限，rtc.c中的代码，我们不全部贴出了，只针对几个重要的函数进行介绍。

       rtc.h头文件只有函数的声明，下面我们直接介绍rtc.c的程序，先看RTC的初始化函数，其定义如下：

/**
 * @brief     RTC初始化
 * @note        默认尝试使用LSE,当LSE启动失败后,切换为LSI.
 *               通过BKP寄存器0的值,可以判断RTC使用的是LSE/LSI:
 *               当BKP0==0x5050时,使用的是LSE
 *               当BKP0==0x5051时,使用的是LSI
 *               注意:切换LSI/LSE将导致时间/日期丢失,切换后需重新设置.
 *
 * @param      无
 * @retval     0,成功
 *               1,进入初始化模式失败
 */
uint8_t rtc_init(void)
{
    uint16_t bkpflag = 0;
 
    g_rtc_handle.Instance = RTC;
    g_rtc_handle.Init.HourFormat = RTC_HOURFORMAT_24;  /* RTC设置为24小时格式 */
    g_rtc_handle.Init.AsynchPrediv = 0x7F; /* RTC异步分频系数(1~0x7F) */
    g_rtc_handle.Init.SynchPrediv = 0xFF; /* RTC同步分频系数(0~0x7FFF) */
    g_rtc_handle.Init.OutPut = RTC_OUTPUT_DISABLE;
    g_rtc_handle.Init.OutPutPolarity = RTC_OUTPUT_POLARITY_HIGH;
    g_rtc_handle.Init.OutPutType = RTC_OUTPUT_TYPE_OPENDRAIN;
 
    /* 检查是不是第一次配置时钟 */
    bkpflag = rtc_read_bkr(0);      /* 读取BKP0的值 */
 
    if (HAL_RTC_Init(&g_rtc_handle) != HAL_OK)
    {
        return 1;
    }
 
    if ((bkpflag != 0x5050) && (bkpflag != 0x5051))  /* 之前未初始化过, 重新配置 */
    {
        rtc_set_time(6, 59, 56, RTC_HOURFORMAT12_AM);/* 设置时间, 根据实际时间修改 */
        rtc_set_date(23, 7, 1, 3);      /* 设置日期 */
    }
    return 0;
}

       该函数用来初始化RTC配置以及日期和时钟，但是只在第一次的时候设置时间，以后如果重新上电/复位都不会再进行时间设置了（前提是备份电池有电）。在第一次配置的时候，我们是按照上面介绍的RTC初始化步骤调用函数（HAL_RTC_Init来实现的）。

       我们通过读取BKP寄存器0的值来判断是否需要进行时间的设置，对BKP寄存器0的写操作是在HAL_RTC_MspInit回调函数中实现，下面会讲。第一次未对RTC进行初始化BKP寄存器0的值非0x5050非0x5051，当进行RTC初始化时，BKP寄存器0的值就是0x5050或0x5051，所以以上代码操作确保时间只会设置一次，复位时不会重新设置时间。电池正常供电时，我们设置的时间不会因复位或者断电而丢失。

       读取后备寄存器的函数其实还是调用HAL库提供的函数接口，写后备寄存器函数同样也是。这两个函数如下：

uint32_t HAL_RTCEx_BKUPRead(RTC_HandleTypeDef *hrtc, uint32_t BackupRegister);
void HAL_RTCEx_BKUPWrite(RTC_HandleTypeDef *hrtc, uint32_t BackupRegister, 
uint32_t Data);

       这两个函数的使用方法就非常简单，分别用来读和写BKR寄存器的值。这里我们只是略微介绍一下。

       我们用HAL_RTC_MspInit函数来编写RTC时钟配等代码，其定义如下：

/**
 * @brief       RTC底层驱动，时钟配置
 * @param       hrtc : RTC句柄
 * @note        此函数会被HAL_RTC_Init()调用
 * @retval      无
 */
void HAL_RTC_MspInit(RTC_HandleTypeDef* hrtc)
{
    uint16_t retry = 200;
 
    RCC_OscInitTypeDef rcc_osc_init_handle;
    RCC_PeriphCLKInitTypeDef rcc_periphclk_init_handle;
 
    __HAL_RCC_RTC_ENABLE();    /* RTC使能 */
    HAL_PWR_EnableBkUpAccess(); /* 取消备份区域写保护 */
    __HAL_RCC_PWR_CLK_ENABLE(); /* 使能电源时钟PWR */
    __HAL_RCC_RTC_ENABLE();   /* RTC使能 */
 
    /* 使用寄存器的方式去检测LSE是否可以正常工作 */
    RCC->BDCR |= 1 << 0;      /* 尝试开启LSE */
 
    while (retry && ((RCC->BDCR & 0x02) == 0))  /* 等待LSE准备好 */
    {
        retry--;
        delay_ms(5);
    }
    
    if (retry == 0)        /* LSE起振失败 使用LSI */
{
   /* 选择要配置的振荡器 */
        rcc_osc_init_handle.OscillatorType = RCC_OSCILLATORTYPE_LSI;
        rcc_osc_init_handle.PLL.PLLState = RCC_PLL_NONE;  /* PLL不配置 */
        rcc_osc_init_handle.LSIState = RCC_LSI_ON;         /* LSI状态:开启 */
        HAL_RCC_OscConfig(&rcc_osc_init_handle);/* 配置设置的rcc_oscinitstruct */
 
   /* 选择要配置外设 RTC */
        rcc_periphclk_init_handle.PeriphClockSelection = RCC_PERIPHCLK_RTC;
   /* RTC时钟源选择LSI */
        rcc_periphclk_init_handle.RTCClockSelection = RCC_RTCCLKSOURCE_LSI;
   /* 配置设置的rcc_periphclkinitstruct */
        HAL_RCCEx_PeriphCLKConfig(&rcc_periphclk_init_handle);
        rtc_write_bkr(0, 0x5051);
    }
    else
{
    /* 选择要配置的振荡器 */
        rcc_osc_init_handle.OscillatorType = RCC_OSCILLATORTYPE_LSE;
        rcc_osc_init_handle.PLL.PLLState = RCC_PLL_NONE;   /* PLL不配置 */
        rcc_osc_init_handle.LSEState = RCC_LSE_ON;          /* LSE状态:开启 */
        HAL_RCC_OscConfig(&rcc_osc_init_handle); /* 配置设置的rcc_oscinitstruct */
 
   /* 选择要配置外设RTC */
        rcc_periphclk_init_handle.PeriphClockSelection = RCC_PERIPHCLK_RTC;
   /* RTC时钟源选择LSE */
        rcc_periphclk_init_handle.RTCClockSelection = RCC_RTCCLKSOURCE_LSE;
   /* 配置设置的rcc_periphclkinitstruct */
        HAL_RCCEx_PeriphCLKConfig(&rcc_periphclk_init_handle);
        rtc_write_bkr(0, 0x5050);
    }
}

       接着，我们介绍一下rtc_set_alarma函数，其定义如下：

/**
 * @breif       设置闹钟时间(按星期闹铃,24小时制)
 * @param       week         : 星期几(1~7)
 * @param       hour,min,sec : 小时,分钟,秒钟
 * @retval      无
 */
void rtc_set_alarma(uint8_t week, uint8_t hour, uint8_t min, uint8_t sec)
{ 
    RTC_AlarmTypeDef rtc_alarm_handle;
    
    rtc_alarm_handle.AlarmTime.Hours = hour;    /* 小时 */
    rtc_alarm_handle.AlarmTime.Minutes = min;   /* 分钟 */
    rtc_alarm_handle.AlarmTime.Seconds = sec;   /* 秒 */
    rtc_alarm_handle.AlarmTime.SubSeconds = 0;
    rtc_alarm_handle.AlarmTime.TimeFormat = RTC_HOURFORMAT12_AM;
    
    rtc_alarm_handle.AlarmMask = RTC_ALARMMASK_NONE;    /* 精确匹配星期，时分秒 */
    rtc_alarm_handle.AlarmSubSecondMask=RTC_ALARMSUBSECONDMASK_NONE; /* 按星期 */
    rtc_alarm_handle.AlarmDateWeekDaySel = RTC_ALARMDATEWEEKDAYSEL_WEEKDAY;
    rtc_alarm_handle.AlarmDateWeekDay = week;   /* 星期 */
    rtc_alarm_handle.Alarm = RTC_ALARM_A;      /* 闹钟A */
    HAL_RTC_SetAlarm_IT(&g_rtc_handle, &rtc_alarm_handle, RTC_FORMAT_BIN);
    
    HAL_NVIC_SetPriority(RTC_Alarm_IRQn, 1, 2);  /* 抢占优先级1, 子优先级2 */
    HAL_NVIC_EnableIRQ(RTC_Alarm_IRQn);
}

       该函数用于设置闹钟A，也就是设置ALRMAR和ALRMASSR寄存器的值，来设置闹钟时间，这里使用HAL库的HAL_RTC_SetAlarm_IT函数来初始化闹钟相关寄存器，前面已经介绍过这个函数，请回顾。

       调用函数rtc_set_wakeup设置闹钟A的参数之后，最后，开启闹钟A中断（连接在外部中断线17），并设置中断分组。当RTC的时间和闹钟A设置的时间完全匹配时，将产生闹钟中断。

       接着，我们介绍一下rtc_set_wakeup函数，该函数代码如下：

/**
 * @breif       周期性唤醒定时器设置
 * @param       wksel
 *   @arg       RTC_WAKEUPCLOCK_RTCCLK_DIV16        ((uint32_t)0x00000000)
 *   @arg       RTC_WAKEUPCLOCK_RTCCLK_DIV8         ((uint32_t)0x00000001)
 *   @arg       RTC_WAKEUPCLOCK_RTCCLK_DIV4         ((uint32_t)0x00000002)
 *   @arg       RTC_WAKEUPCLOCK_RTCCLK_DIV2         ((uint32_t)0x00000003)
 *   @arg       RTC_WAKEUPCLOCK_CK_SPRE_16BITS      ((uint32_t)0x00000004)
 *   @arg       RTC_WAKEUPCLOCK_CK_SPRE_17BITS      ((uint32_t)0x00000006)
 * @note        000,RTC/16;001,RTC/8;010,RTC/4;011,RTC/2;
 *               10x,选择ck_spre（通常是1HZ）;
*               11x,选择ck_spre（通常是1HZ）并使用2^16作为计数值
 * @note        注意:RTC就是RTC的时钟频率,即RTCCLK!
 * @param       cnt: 自动重装载值.减到0,产生中断.
 * @retval      无
 */
void rtc_set_wakeup(uint8_t wksel, uint16_t cnt)
{ 
/* 清除RTC WAKE UP的标志 */
    __HAL_RTC_WAKEUPTIMER_CLEAR_FLAG(&g_rtc_handle, RTC_FLAG_WUTF);  
    HAL_RTCEx_SetWakeUpTimer_IT(&g_rtc_handle, cnt, wksel);/* 设置重装载值和时钟 */
    HAL_NVIC_SetPriority(RTC_WKUP_IRQn, 2, 2);  /* 抢占优先级2,子优先级2 */
    HAL_NVIC_EnableIRQ(RTC_WKUP_IRQn);
}

       该函数用于设置RTC周期性唤醒定时器，实现周期性唤醒中断，连接在外部中断线20。该函数调用的是HAL库函数HAL_RTCEx_SetWakeUpTimer_IT实现的。

       有了中断设置函数，就必定有中断服务函数，同时因为HAL库会开放中断处理回调函数，接下来看这两个中断的中断服务函数和中断处理回调函数，代码如下：

/**
 * @breif       RTC闹钟中断服务函数
 * @param       无
 * @retval      无
 */
void RTC_Alarm_IRQHandler(void)
{
    HAL_RTC_AlarmIRQHandler(&g_rtc_handle);
}
 
/**
 * @breif       RTC闹钟A中断处理回调函数
 * @param       hrtc : RTC句柄
 * @retval      无
 */
void HAL_RTC_AlarmAEventCallback(RTC_HandleTypeDef *hrtc)
{
    printf("ALARM A!\r\n");
}
 
/**
 * @breif       RTC WAKE UP中断服务函数
 * @param       无
 * @retval      无
 */
void RTC_WKUP_IRQHandler(void)
{
    HAL_RTCEx_WakeUpTimerIRQHandler(&g_rtc_handle); 
}
 
/**
 * @breif       RTC WAKE UP中断处理处理回调函数
 * @param       hrtc : RTC句柄
 * @retval      无
 */
void HAL_RTCEx_WakeUpTimerEventCallback(RTC_HandleTypeDef *hrtc)
{
    LED1_TOGGLE();
}

       其中，RTC_Alarm_IRQHandler函数用于闹钟中断，其中断控制逻辑写在中断回调函数HAL_RTC_AlarmAEventCallback中，每当闹钟A闹铃时，会从串口打印一个字符串“ALARM A!”。RTC_WKUP_IRQHandler函数用于RTC自动唤醒定时器中断, 其中断控制逻辑写在中断回调函数HAL_RTCEx_WakeUpTimerEventCallback中，可以通过观察LED1的状态来查看RTC自动唤醒中断的情况。

       rtc.c的其他程序，这里就不再介绍了，请大家直接看源码。

       2. main.c代码

       main函数代码如下：

int main(void)
{
    uint8_t hour, min, sec, ampm;
    uint8_t year, month, date, week;
    uint8_t tbuf[40];
    uint8_t t=0;
 
    HAL_Init();                               /* 初始化HAL库 */
    sys_stm32_clock_init(85, 2, 2, 4, 8);  /* 设置时钟, 170Mhz */
    delay_init(170);                         /* 延时初始化 */
    usart_init(115200);                     /* 串口初始化为115200 */
    usmart_dev.init(170);                   /* 初始化USMART */
    led_init();                               /* 初始化LED */
    lcd_init();                               /* 初始化LCD */
    rtc_init();                               /* 初始化RTC */
    /* 配置WAKE UP中断,1秒钟中断一次 */
    rtc_set_wakeup(RTC_WAKEUPCLOCK_CK_SPRE_16BITS, 0);  
    lcd_show_string(10, 10, 140, 32, 32, "STM32", RED);
    lcd_show_string(10, 42, 140, 24, 24, "RTC TEST", RED);
    lcd_show_string(10, 66, 140, 24, 24, "ATOM@ALIENTEK", RED);
    while (1)
    {
        t++;
        if ((t % 10) == 0)  /* 每100ms更新一次显示数据 */
        {
            rtc_get_time(&hour, &min, &sec, &m);
            sprintf((char *)tbuf, "Time:%02d:%02d:%02d", hour, min, sec);
            lcd_show_string(10, 90, 239, 24, 24, (char*)tbuf, RED);
            rtc_get_date(&year, &month, &date, &week);
            sprintf((char *)tbuf, "Date:20%02d-%02d-%02d", year, month, date);
            lcd_show_string(10, 114, 239, 24, 24, (char*)tbuf, RED);
            sprintf((char *)tbuf, "Week:%d", week);
            lcd_show_string(10, 138, 239, 24, 24, (char*)tbuf, RED);
        }
        if ((t % 20) == 0)
        {
            LED0_TOGGLE();  /* 每200ms,翻转一次LED0 */
        }        
        delay_ms(10);
    }
}

       我们通过rtc_set_wakeup(RTC_WAKEUPCLOCK_CK_SPRE_16BITS,0)设置RTC周期性自动唤醒周期为1秒钟。然后，在无限循环中每100ms读取RTC的时间和日期（一次），并显示在LCD上面。每200ms，翻转一次LED0。

       为方便RTC相关函数的调用验证，在usmart_config.c里面，修改了usmart_nametab如下：

/* 函数名列表初始化(用户自己添加)
 * 用户直接在这里输入要执行的函数名及其查找串
 */
struct _m_usmart_nametab usmart_nametab[] =
{
#if USMART_USE_WRFUNS == 1      /* 如果使能了读写操作 */
    (void *)read_addr, "uint32_t read_addr(uint32_t addr)",
    (void *)write_addr, "void write_addr(uint32_t addr,uint32_t val)",
#endif
    (void *)delay_ms, "void delay_ms(uint16_t nms)",
    (void *)delay_us, "void delay_us(uint32_t nus)",
        
    (void *)rtc_read_bkr, "uint32_t rtc_read_bkr(uint32_t bkrx)",
    (void *)rtc_write_bkr, "void rtc_write_bkr(uint32_t bkrx, uint32_t data)",
(void *)rtc_set_time, "uint8_t rtc_set_time(uint8_t hour, uint8_t min,
uint8_t sec, uint8_t ampm)",
(void *)rtc_set_date, "uint8_t rtc_set_date(uint8_t year, uint8_t month,
uint8_t date, uint8_t week)",
 
    (void *)rtc_set_wakeup, "void rtc_set_wakeup(uint8_t wksel, uint16_t cnt)",
(void *)rtc_get_week, "uint8_t rtc_get_week(uint16_t year, uint8_t month,
uint8_t day)",
(void *)rtc_set_alarma, "void rtc_set_alarma(uint8_t week, uint8_t hour,
uint8_t min, uint8_t sec)",
};

       将RTC的一些相关函数加入了usmart，这样通过串口就可以直接设置RTC时间、日期、闹钟A和周期性唤醒等操作。至此，RTC实时时钟的软件设计就完成了，接下来就让我们来检验一下，我们的程序是否正确。

        2 2 .4 下载验证

       将程序下载到开发板后，可以看到LED0不停的闪烁，提示程序已经在运行了，同时LED1每两秒闪烁一次，说明周期性唤醒中断工作正常。然后，可以看到LCD模块开始显示时间，实际显示效果如图22.4.1所示：

图22.4.1 RTC实验测试图

       如果时间和日期不正确，可以利用上一章介绍的usmart工具，通过串口来设置，并且可以设置闹钟时间等，如图22.4.2所示：

图22.4.2 通过USMART设置时间和日期并测试闹钟A

       按照图中编号6、7、8顺序，设置闹钟A、设置日期、设置时间。然后等待我们设置的时间到来后，串口打印ALARM A!这个字符串，证明我们的闹钟A程序正常运行了！