bsp: k230: add rtc driver

Requirement: The BSP for the k230 platform in the RT-Thread repository
does not yet have an RTC driver.

Solution: Provide RTC drivers for the k230 platform in the RT-Thread
repository, implementing timekeeping and alarm functionalities,
with interrupt support for the alarm feature.

Signed-off-by: Ze-Hou <yingkezhou@qq.com>

Author: Ze-Hou

bsp/k230/.config

@@ -358,7 +358,7 @@ CONFIG_RT_BLK_PARTITION_EFI=y
 # CONFIG_RT_USING_VIRTIO is not set
 CONFIG_RT_USING_PIN=y
 CONFIG_RT_USING_KTIME=y
-CONFIG_RT_USING_HWTIMER=y
+# CONFIG_RT_USING_HWTIMER is not set
 # CONFIG_RT_USING_CHERRYUSB is not set
 # end of Device Drivers
 
@@ -521,11 +521,7 @@ CONFIG_RT_LWIP_USING_PING=y
 #
 # CONFIG_RT_USING_RYM is not set
 # CONFIG_RT_USING_ULOG is not set
-CONFIG_RT_USING_UTEST=y
-CONFIG_UTEST_THR_STACK_SIZE=4096
-CONFIG_UTEST_THR_PRIORITY=20
-# CONFIG_RT_UTEST_USING_AUTO_RUN is not set
-# CONFIG_RT_UTEST_USING_ALL_CASES is not set
+# CONFIG_RT_USING_UTEST is not set
 # CONFIG_RT_USING_VAR_EXPORT is not set
 CONFIG_RT_USING_RESOURCE_ID=y
 CONFIG_RT_USING_ADT=y
@@ -1621,7 +1617,7 @@ CONFIG_PKG_ZLIB_VER="latest"
 #
 # Drivers Configuration
 #
-CONFIG_BSP_USING_RTC=y
+# CONFIG_BSP_USING_RTC is not set
 # CONFIG_BSP_USING_ADC is not set
 # CONFIG_BSP_USING_TS is not set
 CONFIG_BSP_USING_UART=y
@@ -1634,13 +1630,15 @@ CONFIG_BSP_USING_UART0=y
 # CONFIG_BSP_USING_PWM is not set
 CONFIG_BSP_USING_HARDLOCK=y
 CONFIG_BSP_USING_SDIO=y
-# CONFIG_BSP_USING_SDIO0 is not set
-CONFIG_BSP_USING_SDIO1=y
-CONFIG_BSP_SD_MNT_DEVNAME="sd1p1"
+CONFIG_BSP_USING_SDIO0=y
+# CONFIG_BSP_SDIO0_EMMC is not set
+# CONFIG_BSP_SDIO0_1V8 is not set
+# CONFIG_BSP_USING_SDIO1 is not set
+CONFIG_BSP_SD_MNT_DEVNAME="sd0p1"
 # CONFIG_BSP_USING_TIMERS is not set
 # CONFIG_BSP_USING_WDT is not set
 # CONFIG_BSP_USING_PDMA is not set
-CONFIG_BSP_UTEST_DRIVERS=y
+# CONFIG_BSP_UTEST_DRIVERS is not set
 # end of Drivers Configuration
 
 CONFIG_BOARD_C908=y

bsp/k230/board/Kconfig

@@ -9,7 +9,7 @@ menu "Drivers Configuration"
         bool "Enable ADC"
         select RT_USING_ADC
         default n
-    
+
     config BSP_USING_TS
         bool "Enable Temperature Sensor"
         select RT_USING_TS
@@ -32,15 +32,15 @@ menu "Drivers Configuration"
             config BSP_USING_UART1
                 bool "Enable UART1"
                 default n
-            
+
             config BSP_USING_UART2
                 bool "Enable UART2"
                 default n
-            
+
             config BSP_USING_UART3
                 bool "Enable UART3"
                 default n
-            
+
             config BSP_USING_UART4
                 bool "Enable UART4"
                 default n
@@ -151,37 +151,37 @@ menu "Drivers Configuration"
     menuconfig BSP_USING_PDMA
         bool "Enable PDMA"
         select RT_USING_PDMA
-        default n 
-         
+        default n
+
         if BSP_USING_PDMA
             config BSP_USING_PDMA_CHANNEL0
                 bool "Enable PDMA Channel 0"
                 default n
-                
+
             config BSP_USING_PDMA_CHANNEL1
                 bool "Enable PDMA Channel 1"
                 default n
-                
+
             config BSP_USING_PDMA_CHANNEL2
                 bool "Enable PDMA Channel 2"
                 default n
-               
+
             config BSP_USING_PDMA_CHANNEL3
                 bool "Enable PDMA Channel 3"
                 default n
-            
+
             config BSP_USING_PDMA_CHANNEL4
                 bool "Enable PDMA Channel 4"
                 default n
-                
+
             config BSP_USING_PDMA_CHANNEL5
                 bool "Enable PDMA Channel 5"
                 default n
-                
+
             config BSP_USING_PDMA_CHANNEL6
                 bool "Enable PDMA Channel 6"
                 default n
-                
+
             config BSP_USING_PDMA_CHANNEL7
                 bool "Enable PDMA Channel 7"
                 default n

bsp/k230/drivers/interdrv/rtc/SConscript

@@ -8,4 +8,4 @@ CPPPATH = [cwd]
 
 group = DefineGroup('RTC', src, depend = ['BSP_USING_RTC'], CPPPATH = CPPPATH)
 
-Return('group')
+Return('group')

bsp/k230/drivers/interdrv/rtc/drv_rtc.c

@@ -63,8 +63,8 @@ static void pmu_isolation_rtc(void)
 
     /* disable pmu isolation */
     data = *addr;
-    data &= ~0x20; 
-    *addr = data;   
+    data &= ~0x20;
+    *addr = data;
     rt_iounmap(reg_pmu_pwr);
 
     /* map pmu base address */
@@ -249,7 +249,7 @@ static void rtc_date_time_set(struct k230_rtc_dev *dev, int year, int month, int
     }
 
     rtc->int_ctrl.timer_w_en = 1;
-    
+
     date.year_h = year_h;
     date.year_l = year_l;
     date.month = month;
@@ -273,7 +273,7 @@ static void rtc_timer_get(struct k230_rtc_dev *dev, time_t *t)
     {
         rtc->int_ctrl.timer_r_en = 1;
     }
-    
+
     tm.tm_sec = rtc->time.second;
     tm.tm_min = rtc->time.minute;
     tm.tm_hour = rtc->time.hour;
@@ -289,7 +289,7 @@ static void rtc_timer_set(struct k230_rtc_dev *dev, time_t *t)
 {
     struct tm p_tm;
     gmtime_r(t, &p_tm);
-    
+
     rtc_date_time_set(dev, (p_tm.tm_year + 1900), p_tm.tm_mon + 1, p_tm.tm_mday, \
                       p_tm.tm_hour, p_tm.tm_min, p_tm.tm_sec, p_tm.tm_wday);
 
@@ -302,7 +302,7 @@ static void rtc_alarm_get(struct k230_rtc_dev *dev, void *args)
     volatile rtc_t *rtc = (rtc_t *)dev->base;
     rtc_alarm_date_t alarm_date = rtc->alarm_date;
     rtc_alarm_time_t alarm_time = rtc->alarm_time;
-    
+
     tm->tm_year = (alarm_date.alarm_year_h * 100 + alarm_date.alarm_year_l) -1900;
     tm->tm_mon = alarm_date.alarm_month - 1;
     tm->tm_mday = alarm_date.alarm_day;
@@ -313,16 +313,21 @@ static void rtc_alarm_get(struct k230_rtc_dev *dev, void *args)
 
 static void rtc_alarm_set(struct k230_rtc_dev *dev, void *args)
 {
-    struct kd_alarm_setup *setup = (struct kd_alarm_setup*)args;
+    rtc_alarm_setup_t *setup = (rtc_alarm_setup_t *)args;
     struct tm tm = setup->tm;
+    time_t t;
+    struct tm p_tm;
     volatile rtc_t *rtc = (rtc_t *)dev->base;
     rtc_alarm_time_t alarm_time;
     rtc_alarm_date_t alarm_date;
     rtc_date_t date = rtc->date;
+    int year, year_l, year_h, val;
 
-    int year = tm.tm_year + 1900;
-    int val = year % 100;
-    int year_l,year_h;
+    t = mktime(&tm);
+    gmtime_r(&t, &p_tm);
+
+    year = p_tm.tm_year + 1900;
+    val = year % 100;
 
     if(val == 0)
     {
@@ -337,11 +342,11 @@ static void rtc_alarm_set(struct k230_rtc_dev *dev, void *args)
 
     alarm_date.alarm_year_h = year_h;
     alarm_date.alarm_year_l = year_l;
-    alarm_date.alarm_month = tm.tm_mon + 1;
-    alarm_date.alarm_day = tm.tm_mday;
-    alarm_time.alarm_hour = tm.tm_hour;
-    alarm_time.alarm_minute = tm.tm_min;
-    alarm_time.alarm_second = tm.tm_sec;
+    alarm_date.alarm_month = p_tm.tm_mon + 1;
+    alarm_date.alarm_day = p_tm.tm_mday;
+    alarm_time.alarm_hour = p_tm.tm_hour;
+    alarm_time.alarm_minute = p_tm.tm_min;
+    alarm_time.alarm_second = p_tm.tm_sec;
 
     rtc->alarm_date = alarm_date;
     rtc->alarm_time = alarm_time;
@@ -424,7 +429,7 @@ static rt_err_t rtc_device_control(rt_device_t dev, int cmd, void *args)
         rtc_dev->vector_callback = args;
         break;
     default:
-        return RT_EINVAL;
+        return -RT_EINVAL;
     }
     return RT_EOK;
 }
@@ -439,7 +444,7 @@ const static struct rt_device_ops rtc_ops =
     .control = rtc_device_control,
 };
 
-static struct k230_rtc_dev rtc_dev = 
+static struct k230_rtc_dev rtc_dev =
 {
     .name = "rtc",
     .base = RTC_BASE_ADDR,
@@ -478,4 +483,4 @@ static int rt_hw_rtc_init(void)
     rtc_tick_stop(&rtc_dev);
     return ret;
 }
-INIT_DEVICE_EXPORT(rt_hw_rtc_init);
+INIT_DEVICE_EXPORT(rt_hw_rtc_init);

bsp/k230/drivers/interdrv/rtc/drv_rtc.h

@@ -152,10 +152,10 @@ typedef enum _rtc_tick_interrupt_mode_e
     RTC_INT_TICK_S64,
 } rtc_interrupt_mode_t;
 
-struct kd_alarm_setup
+typedef struct _rtc_alarm_setup
 {
     rt_uint32_t flag;               /* alarm flag */
     struct tm tm;                   /* when will the alarm wake up user */
-};
+} rtc_alarm_setup_t;
 
-#endif /* __DRV_RTC_H__ */
+#endif /* __DRV_RTC_H__ */

bsp/k230/drivers/utest/test_rtc.c

@@ -36,20 +36,29 @@
 #include <finsh.h>
 #include "drv_rtc.h"
 
-/* 
- * 测试RTC的时间功能与闹钟功能，在RTCd的寄存器中保存的时间信息
- * 是以UTC时间保存的，要使用本地时间需要配置时区，当前配置的时
+/*
+ * 测试 RTC 的时间功能与闹钟功能，在RTCd的寄存器中保存的时间信息
+ * 是以 UTC 时间保存的，要使用本地时间需要配置时区，当前配置的时
  * 区是东八区，即北京时间（CST）
- * 
- * 在设置时间日期时使用set_time()与set_date()接口，设置的时间
- * 这两个接口内部会做时区转换
+ *
+ * 在设置时间日期时使用 set_time() 与 set_date() 接口，设置的时
+ * 间这两个接口内部会做时区转换
  *
  * 测试说明：
- * 基于庐山派开发板测试
- * RTC为K230自带的RTC
- * RTC的时钟源为外部32.768KHz晶振
- * 在测试终端运行该测试后，会分别进行test_rtc_set(), 
- * test_rtc_alarm()与test_rtc_interface()三个测试
+ * 基于庐山派开发板测试（01Studio 的开发板无法使用硬件RTC，
+ * 因为没有接 int0/4 的上拉）
+ *  RTC 为 K230 自带的 RTC
+ * RTC 的时钟源为外部 32.768KHz 晶振
+ * 在测试终端运行该测试后，会分别进行 test_rtc_set(),
+ * test_rtc_alarm() 与 test_rtc_interface() 三个测试。
+ * 其中 test_rtc_set() 会通过 set_time() 与 set_date() 设置时间，
+ * 注意设置的时间需要为本地时间，内部会转换成 UTC 时间，然后调用
+ * drv_rtc.c 内的接口设置到 RTC 寄存器中；
+ * test_rtc_alarm() 会设置一个 5 秒后的闹钟时间，并注册一个闹钟
+ * 中断回调函数，同样用户设置的闹钟时间为本地时间，内部会转换成UTC
+ * 时间然后保存进 RTC 中；
+ * test_rtc_interface() 会测试读写 RTC 的接口，写 RTC 时同样需要
+ * 提供本地时间，读出来后需要转换成本地时间（如果有需要）。
  */
 
 #define RTC_NAME       "rtc"
@@ -95,7 +104,7 @@ static void test_rtc_alarm(void)
     struct tm p_tm;
     rt_device_t rtc_dev = RT_NULL;
     struct rt_alarm *alarm = RT_NULL;
-    struct kd_alarm_setup setup;
+    rtc_alarm_setup_t setup;
 
     LOG_I("rtc alarm test\n");
     rtc_dev = rt_device_find(RTC_NAME);
@@ -110,7 +119,7 @@ static void test_rtc_alarm(void)
     now = time(RT_NULL);
     LOG_I("%s\n", ctime(&now));
     now += 5; //alarm after 5s
-    gmtime_r(&now, &p_tm);
+    localtime_r(&now, &p_tm);
 
     setup.flag = RTC_INT_ALARM_MINUTE | RTC_INT_ALARM_SECOND;
     setup.tm.tm_year = p_tm.tm_year;
@@ -120,7 +129,7 @@ static void test_rtc_alarm(void)
     setup.tm.tm_hour = p_tm.tm_hour;
     setup.tm.tm_min = p_tm.tm_min;
     setup.tm.tm_sec = p_tm.tm_sec;
-    
+
     rt_device_control(rtc_dev, RT_DEVICE_CTRL_RTC_SET_CALLBACK, &test_rtc_alarm_callback); //set rtc intr callback
     rt_device_control(rtc_dev, RT_DEVICE_CTRL_RTC_SET_ALARM, &setup);   //set alarm time
     rt_memset(&p_tm, 0, sizeof(p_tm));
@@ -163,7 +172,7 @@ static void test_rtc_interface(void)
     tm.tm_sec = 59;
     rt_device_write(rtc_dev, RT_NULL, (void*)&tm, sizeof(tm));
     rt_thread_mdelay(500);
-    
+
     /* 设置完时间后打印10次时间 */
     for (i=0; i<10; i++)
     {
@@ -205,4 +214,4 @@ static rt_err_t utest_tc_cleanup(void)
 {
     return RT_EOK;
 }
-UTEST_TC_EXPORT(testcase, "bsp.k230.drivers.rtc", utest_tc_init, utest_tc_cleanup, 100);
+UTEST_TC_EXPORT(testcase, "bsp.k230.drivers.rtc", utest_tc_init, utest_tc_cleanup, 100);

bsp/k230/rtconfig.h

@@ -232,7 +232,6 @@
 /* end of Partition Types */
 #define RT_USING_PIN
 #define RT_USING_KTIME
-#define RT_USING_HWTIMER
 /* end of Device Drivers */
 
 /* C/C++ and POSIX layer */
@@ -342,9 +341,6 @@
 
 /* Utilities */
 
-#define RT_USING_UTEST
-#define UTEST_THR_STACK_SIZE 4096
-#define UTEST_THR_PRIORITY 20
 #define RT_USING_RESOURCE_ID
 #define RT_USING_ADT
 #define RT_USING_ADT_AVL
@@ -590,15 +586,13 @@
 
 /* Drivers Configuration */
 
-#define BSP_USING_RTC
 #define BSP_USING_UART
 #define BSP_UART_USING_DMA
 #define BSP_USING_UART0
 #define BSP_USING_HARDLOCK
 #define BSP_USING_SDIO
-#define BSP_USING_SDIO1
-#define BSP_SD_MNT_DEVNAME "sd1p1"
-#define BSP_UTEST_DRIVERS
+#define BSP_USING_SDIO0
+#define BSP_SD_MNT_DEVNAME "sd0p1"
 /* end of Drivers Configuration */
 #define BOARD_C908
 #define __STACKSIZE__ 65536