/* * Copyright (c) 2006-2023, RT-Thread Development Team * * SPDX-License-Identifier: Apache-2.0 * * Change Logs: * Date Author Notes * 2012-10-27 heyuanjie87 first version. * 2013-05-17 aozima initial alarm event & mutex in system init. * 2020-10-15 zhangsz add alarm flags hour minute second. * 2020-11-09 zhangsz fix alarm set when modify rtc time. * 2024-09-29 milo make internal thread's attributes configurable. */ #include #include #include #define RT_RTC_YEARS_MAX 137 #ifdef RT_USING_SOFT_RTC #define RT_ALARM_DELAY 0 #else #define RT_ALARM_DELAY 2 #endif #if (defined(RT_USING_RTC) && defined(RT_USING_ALARM)) #ifndef RT_ALARM_STACK_SIZE #define RT_ALARM_STACK_SIZE 2048 #endif #ifndef RT_ALARM_TIMESLICE #define RT_ALARM_TIMESLICE 5 #endif #ifndef RT_ALARM_PRIORITY #define RT_ALARM_PRIORITY 10 #endif static struct rt_alarm_container _container; rt_inline rt_uint32_t alarm_mkdaysec(struct tm *time) { rt_uint32_t sec; sec = time->tm_sec; sec += time->tm_min * 60; sec += time->tm_hour * 3600; return (sec); } static rt_err_t alarm_set(struct rt_alarm *alarm) { rt_device_t device; struct rt_rtc_wkalarm wkalarm; rt_err_t ret; device = rt_device_find("rtc"); if (device == RT_NULL) { return (RT_ERROR); } if (alarm->flag & RT_ALARM_STATE_START) wkalarm.enable = RT_TRUE; else wkalarm.enable = RT_FALSE; wkalarm.tm_sec = alarm->wktime.tm_sec; wkalarm.tm_min = alarm->wktime.tm_min; wkalarm.tm_hour = alarm->wktime.tm_hour; wkalarm.tm_mday = alarm->wktime.tm_mday; wkalarm.tm_mon = alarm->wktime.tm_mon; wkalarm.tm_year = alarm->wktime.tm_year; ret = rt_device_control(device, RT_DEVICE_CTRL_RTC_SET_ALARM, &wkalarm); if ((ret == RT_EOK) && wkalarm.enable) { ret = rt_device_control(device, RT_DEVICE_CTRL_RTC_GET_ALARM, &wkalarm); if (ret == RT_EOK) { /* some RTC device like RX8025,it's alarms precision is 1 minute. in this case,low level RTC driver should set wkalarm->tm_sec to 0. */ alarm->wktime.tm_sec = wkalarm.tm_sec; alarm->wktime.tm_min = wkalarm.tm_min; alarm->wktime.tm_hour = wkalarm.tm_hour; alarm->wktime.tm_mday = wkalarm.tm_mday; alarm->wktime.tm_mon = wkalarm.tm_mon; alarm->wktime.tm_year = wkalarm.tm_year; } } return (ret); } static void alarm_wakeup(struct rt_alarm *alarm, struct tm *now) { rt_uint32_t sec_alarm, sec_now; rt_bool_t wakeup = RT_FALSE; time_t timestamp; sec_alarm = alarm_mkdaysec(&alarm->wktime); sec_now = alarm_mkdaysec(now); if (alarm->flag & RT_ALARM_STATE_START) { switch (alarm->flag & 0xFF00) { case RT_ALARM_ONESHOT: { sec_alarm = timegm(&alarm->wktime); sec_now = timegm(now); if (((sec_now - sec_alarm) <= RT_ALARM_DELAY) && (sec_now >= sec_alarm)) { /* stop alarm */ alarm->flag &= ~RT_ALARM_STATE_START; alarm_set(alarm); wakeup = RT_TRUE; } } break; case RT_ALARM_SECOND: { alarm->wktime.tm_hour = now->tm_hour; alarm->wktime.tm_min = now->tm_min; alarm->wktime.tm_sec = now->tm_sec + 1; if (alarm->wktime.tm_sec > 59) { alarm->wktime.tm_sec = 0; alarm->wktime.tm_min = alarm->wktime.tm_min + 1; if (alarm->wktime.tm_min > 59) { alarm->wktime.tm_min = 0; alarm->wktime.tm_hour = alarm->wktime.tm_hour + 1; if (alarm->wktime.tm_hour > 23) { alarm->wktime.tm_hour = 0; } } } wakeup = RT_TRUE; } break; case RT_ALARM_MINUTE: { alarm->wktime.tm_hour = now->tm_hour; if (alarm->wktime.tm_sec == now->tm_sec) { alarm->wktime.tm_min = now->tm_min + 1; if (alarm->wktime.tm_min > 59) { alarm->wktime.tm_min = 0; alarm->wktime.tm_hour = alarm->wktime.tm_hour + 1; if (alarm->wktime.tm_hour > 23) { alarm->wktime.tm_hour = 0; } } wakeup = RT_TRUE; } } break; case RT_ALARM_HOUR: { if ((alarm->wktime.tm_min == now->tm_min) && (alarm->wktime.tm_sec == now->tm_sec)) { alarm->wktime.tm_hour = now->tm_hour + 1; if (alarm->wktime.tm_hour > 23) { alarm->wktime.tm_hour = 0; } wakeup = RT_TRUE; } } break; case RT_ALARM_DAILY: { if (((sec_now - sec_alarm) <= RT_ALARM_DELAY) && (sec_now >= sec_alarm)) wakeup = RT_TRUE; } break; case RT_ALARM_WEEKLY: { /* alarm at wday */ if (alarm->wktime.tm_wday == now->tm_wday) { sec_alarm += alarm->wktime.tm_wday * 24 * 3600; sec_now += now->tm_wday * 24 * 3600; if (sec_now == sec_alarm) wakeup = RT_TRUE; } } break; case RT_ALARM_MONTHLY: { /* monthly someday generate alarm signals */ if (alarm->wktime.tm_mday == now->tm_mday) { if ((sec_now - sec_alarm) <= RT_ALARM_DELAY) wakeup = RT_TRUE; } } break; case RT_ALARM_YAERLY: { if ((alarm->wktime.tm_mday == now->tm_mday) && \ (alarm->wktime.tm_mon == now->tm_mon)) { if ((sec_now - sec_alarm) <= RT_ALARM_DELAY) wakeup = RT_TRUE; } } break; } if ((wakeup == RT_TRUE) && (alarm->callback != RT_NULL)) { timestamp = (time_t)0; get_timestamp(×tamp); alarm->callback(alarm, timestamp); } } } static void alarm_update(rt_uint32_t event) { struct rt_alarm *alm_prev = RT_NULL, *alm_next = RT_NULL; struct rt_alarm *alarm; rt_int32_t sec_now, sec_alarm, sec_tmp; rt_int32_t sec_next = 24 * 3600, sec_prev = 0; time_t timestamp = (time_t)0; struct tm now; rt_list_t *next; rt_mutex_take(&_container.mutex, RT_WAITING_FOREVER); if (!rt_list_isempty(&_container.head)) { /* get time of now */ get_timestamp(×tamp); gmtime_r(×tamp, &now); for (next = _container.head.next; next != &_container.head; next = next->next) { alarm = rt_list_entry(next, struct rt_alarm, list); /* check the overtime alarm */ alarm_wakeup(alarm, &now); } /* get time of now */ get_timestamp(×tamp); gmtime_r(×tamp, &now); sec_now = alarm_mkdaysec(&now); for (next = _container.head.next; next != &_container.head; next = next->next) { alarm = rt_list_entry(next, struct rt_alarm, list); /* calculate seconds from 00:00:00 */ sec_alarm = alarm_mkdaysec(&alarm->wktime); if (alarm->flag & RT_ALARM_STATE_START) { sec_tmp = sec_alarm - sec_now; if (sec_tmp > 0) { /* find alarm after now(now to 23:59:59) and the most recent */ if (sec_tmp < sec_next) { sec_next = sec_tmp; alm_next = alarm; } } else { /* find alarm before now(00:00:00 to now) and furthest from now */ if (sec_tmp < sec_prev) { sec_prev = sec_tmp; alm_prev = alarm; } } } } /* enable the alarm after now first */ if (sec_next < 24 * 3600) { if (alarm_set(alm_next) == RT_EOK) _container.current = alm_next; } else if (sec_prev < 0) { /* enable the alarm before now */ if (alarm_set(alm_prev) == RT_EOK) _container.current = alm_prev; } else { if (_container.current != RT_NULL) { alarm_set(_container.current); if (!(_container.current->flag & RT_ALARM_STATE_START)) _container.current = RT_NULL; } } } rt_mutex_release(&_container.mutex); } static int days_of_year_month(int tm_year, int tm_mon) { int ret, year; year = tm_year + 1900; if (tm_mon == 1) { ret = 28 + ((!(year % 4) && (year % 100)) || !(year % 400)); } else if (((tm_mon <= 6) && (tm_mon % 2 == 0)) || ((tm_mon > 6) && (tm_mon % 2 == 1))) { ret = 31; } else { ret = 30; } return (ret); } static rt_bool_t is_valid_date(struct tm *date) { if ((date->tm_year < 0) || (date->tm_year > RT_RTC_YEARS_MAX)) { return (RT_FALSE); } if ((date->tm_mon < 0) || (date->tm_mon > 11)) { return (RT_FALSE); } if ((date->tm_mday < 1) || \ (date->tm_mday > days_of_year_month(date->tm_year, date->tm_mon))) { return (RT_FALSE); } return (RT_TRUE); } static rt_err_t alarm_setup(rt_alarm_t alarm, struct tm *wktime) { rt_err_t ret = -RT_ERROR; time_t timestamp = (time_t)0; struct tm *setup, now; setup = &alarm->wktime; *setup = *wktime; /* get time of now */ get_timestamp(×tamp); gmtime_r(×tamp, &now); /* if these are a "don't care" value,we set them to now*/ if ((setup->tm_sec > 59) || (setup->tm_sec < 0)) setup->tm_sec = now.tm_sec; if ((setup->tm_min > 59) || (setup->tm_min < 0)) setup->tm_min = now.tm_min; if ((setup->tm_hour > 23) || (setup->tm_hour < 0)) setup->tm_hour = now.tm_hour; switch (alarm->flag & 0xFF00) { case RT_ALARM_SECOND: { alarm->wktime.tm_hour = now.tm_hour; alarm->wktime.tm_min = now.tm_min; alarm->wktime.tm_sec = now.tm_sec + 1; if (alarm->wktime.tm_sec > 59) { alarm->wktime.tm_sec = 0; alarm->wktime.tm_min = alarm->wktime.tm_min + 1; if (alarm->wktime.tm_min > 59) { alarm->wktime.tm_min = 0; alarm->wktime.tm_hour = alarm->wktime.tm_hour + 1; if (alarm->wktime.tm_hour > 23) { alarm->wktime.tm_hour = 0; } } } } break; case RT_ALARM_MINUTE: { alarm->wktime.tm_hour = now.tm_hour; alarm->wktime.tm_min = now.tm_min + 1; if (alarm->wktime.tm_min > 59) { alarm->wktime.tm_min = 0; alarm->wktime.tm_hour = alarm->wktime.tm_hour + 1; if (alarm->wktime.tm_hour > 23) { alarm->wktime.tm_hour = 0; } } } break; case RT_ALARM_HOUR: { alarm->wktime.tm_hour = now.tm_hour + 1; if (alarm->wktime.tm_hour > 23) { alarm->wktime.tm_hour = 0; } } break; case RT_ALARM_DAILY: { /* do nothing but needed */ } break; case RT_ALARM_ONESHOT: { /* if these are "don't care" value we set them to now */ if (setup->tm_year == RT_ALARM_TM_NOW) setup->tm_year = now.tm_year; if (setup->tm_mon == RT_ALARM_TM_NOW) setup->tm_mon = now.tm_mon; if (setup->tm_mday == RT_ALARM_TM_NOW) setup->tm_mday = now.tm_mday; /* make sure the setup is valid */ if (!is_valid_date(setup)) goto _exit; } break; case RT_ALARM_WEEKLY: { /* if tm_wday is a "don't care" value we set it to now */ if ((setup->tm_wday < 0) || (setup->tm_wday > 6)) setup->tm_wday = now.tm_wday; } break; case RT_ALARM_MONTHLY: { /* if tm_mday is a "don't care" value we set it to now */ if ((setup->tm_mday < 1) || (setup->tm_mday > 31)) setup->tm_mday = now.tm_mday; } break; case RT_ALARM_YAERLY: { /* if tm_mon is a "don't care" value we set it to now */ if ((setup->tm_mon < 0) || (setup->tm_mon > 11)) setup->tm_mon = now.tm_mon; if (setup->tm_mon == 1) { /* tm_mon is February */ /* tm_mday should be 1~29.otherwise,it's a "don't care" value */ if ((setup->tm_mday < 1) || (setup->tm_mday > 29)) setup->tm_mday = now.tm_mday; } else if (((setup->tm_mon <= 6) && (setup->tm_mon % 2 == 0)) || \ ((setup->tm_mon > 6) && (setup->tm_mon % 2 == 1))) { /* Jan,Mar,May,Jul,Aug,Oct,Dec */ /* tm_mday should be 1~31.otherwise,it's a "don't care" value */ if ((setup->tm_mday < 1) || (setup->tm_mday > 31)) setup->tm_mday = now.tm_mday; } else { /* tm_mday should be 1~30.otherwise,it's a "don't care" value */ if ((setup->tm_mday < 1) || (setup->tm_mday > 30)) setup->tm_mday = now.tm_mday; } } break; default: { goto _exit; } } if ((setup->tm_hour == 23) && (setup->tm_min == 59) && (setup->tm_sec == 59)) { /* for insurance purposes, we will generate an alarm signal two seconds ahead of. */ setup->tm_sec = 60 - RT_ALARM_DELAY; } /* set initialized state */ alarm->flag |= RT_ALARM_STATE_INITED; ret = RT_EOK; _exit: return (ret); } /** \brief send a rtc alarm event * * \param dev pointer to RTC device(currently unused,you can ignore it) * \param event RTC event(currently unused) * \return none */ void rt_alarm_update(rt_device_t dev, rt_uint32_t event) { rt_event_send(&_container.event, 1); } /** \brief modify the alarm setup * * \param alarm pointer to alarm * \param cmd control command * \param arg argument */ rt_err_t rt_alarm_control(rt_alarm_t alarm, int cmd, void *arg) { rt_err_t ret = -RT_ERROR; RT_ASSERT(alarm != RT_NULL); rt_mutex_take(&_container.mutex, RT_WAITING_FOREVER); switch (cmd) { case RT_ALARM_CTRL_MODIFY: { struct rt_alarm_setup *setup; RT_ASSERT(arg != RT_NULL); setup = arg; rt_alarm_stop(alarm); alarm->flag = setup->flag & 0xFF00; alarm->wktime = setup->wktime; ret = alarm_setup(alarm, &alarm->wktime); } break; } rt_mutex_release(&_container.mutex); return (ret); } /** \brief start an alarm * * \param alarm pointer to alarm * \return RT_EOK */ rt_err_t rt_alarm_start(rt_alarm_t alarm) { rt_int32_t sec_now, sec_old, sec_new; rt_err_t ret = RT_EOK; time_t timestamp = (time_t)0; struct tm now; if (alarm == RT_NULL) return (RT_ERROR); rt_mutex_take(&_container.mutex, RT_WAITING_FOREVER); if (!(alarm->flag & RT_ALARM_STATE_START)) { if (alarm_setup(alarm, &alarm->wktime) != RT_EOK) { ret = -RT_ERROR; goto _exit; } /* get time of now */ get_timestamp(×tamp); gmtime_r(×tamp, &now); alarm->flag |= RT_ALARM_STATE_START; /* set alarm */ if (_container.current == RT_NULL) { ret = alarm_set(alarm); } else { sec_now = alarm_mkdaysec(&now); sec_old = alarm_mkdaysec(&_container.current->wktime); sec_new = alarm_mkdaysec(&alarm->wktime); if ((sec_new < sec_old) && (sec_new > sec_now)) { ret = alarm_set(alarm); } else if ((sec_new > sec_now) && (sec_old < sec_now)) { ret = alarm_set(alarm); } else if ((sec_new < sec_old) && (sec_old < sec_now)) { ret = alarm_set(alarm); } else { ret = RT_EOK; goto _exit; } } if (ret == RT_EOK) { _container.current = alarm; } } _exit: rt_mutex_release(&_container.mutex); return (ret); } /** \brief stop an alarm * * \param alarm pointer to alarm * \return RT_EOK */ rt_err_t rt_alarm_stop(rt_alarm_t alarm) { rt_err_t ret = RT_EOK; if (alarm == RT_NULL) return (RT_ERROR); rt_mutex_take(&_container.mutex, RT_WAITING_FOREVER); if (!(alarm->flag & RT_ALARM_STATE_START)) goto _exit; /* stop alarm */ alarm->flag &= ~RT_ALARM_STATE_START; if (_container.current == alarm) { ret = alarm_set(alarm); _container.current = RT_NULL; } if (ret == RT_EOK) alarm_update(0); _exit: rt_mutex_release(&_container.mutex); return (ret); } /** \brief delete an alarm * * \param alarm pointer to alarm * \return RT_EOK */ rt_err_t rt_alarm_delete(rt_alarm_t alarm) { rt_err_t ret = RT_EOK; if (alarm == RT_NULL) return -RT_ERROR; rt_mutex_take(&_container.mutex, RT_WAITING_FOREVER); /* stop the alarm */ alarm->flag &= ~RT_ALARM_STATE_START; if (_container.current == alarm) { ret = alarm_set(alarm); _container.current = RT_NULL; /* set new alarm if necessary */ alarm_update(0); } rt_list_remove(&alarm->list); rt_free(alarm); rt_mutex_release(&_container.mutex); return (ret); } /** \brief create an alarm * * \param flag set alarm mode e.g: RT_ALARM_DAILY * \param setup pointer to setup infomation */ rt_alarm_t rt_alarm_create(rt_alarm_callback_t callback, struct rt_alarm_setup *setup) { struct rt_alarm *alarm; if (setup == RT_NULL) return (RT_NULL); alarm = rt_malloc(sizeof(struct rt_alarm)); if (alarm == RT_NULL) return (RT_NULL); rt_list_init(&alarm->list); alarm->wktime = setup->wktime; alarm->flag = setup->flag & 0xFF00; alarm->callback = callback; rt_mutex_take(&_container.mutex, RT_WAITING_FOREVER); rt_list_insert_after(&_container.head, &alarm->list); rt_mutex_release(&_container.mutex); return (alarm); } /** \brief rtc alarm service thread entry * */ static void rt_alarmsvc_thread_init(void *param) { rt_uint32_t recv; _container.current = RT_NULL; while (1) { if (rt_event_recv(&_container.event, 0xFFFF, RT_EVENT_FLAG_OR | RT_EVENT_FLAG_CLEAR, RT_WAITING_FOREVER, &recv) == RT_EOK) { alarm_update(recv); } } } struct _alarm_flag { const char* name; rt_uint32_t flag; }; static const struct _alarm_flag _alarm_flag_tbl[] = { {"N", 0xffff}, /* none */ {"O", RT_ALARM_ONESHOT}, /* only alarm once */ {"D", RT_ALARM_DAILY}, /* alarm everyday */ {"W", RT_ALARM_WEEKLY}, /* alarm weekly at Monday or Friday etc. */ {"Mo", RT_ALARM_MONTHLY}, /* alarm monthly at someday */ {"Y", RT_ALARM_YAERLY}, /* alarm yearly at a certain date */ {"H", RT_ALARM_HOUR}, /* alarm each hour at a certain min:second */ {"M", RT_ALARM_MINUTE}, /* alarm each minute at a certain second */ {"S", RT_ALARM_SECOND}, /* alarm each second */ }; static rt_uint8_t _alarm_flag_tbl_size = sizeof(_alarm_flag_tbl) / sizeof(_alarm_flag_tbl[0]); static rt_uint8_t get_alarm_flag_index(rt_uint32_t alarm_flag) { for (rt_uint8_t index = 0; index < _alarm_flag_tbl_size; index++) { alarm_flag &= 0xff00; if (alarm_flag == _alarm_flag_tbl[index].flag) { return index; } } return 0; } void rt_alarm_dump(void) { rt_list_t *next; rt_alarm_t alarm; rt_kprintf("| hh:mm:ss | week | flag | en |\n"); rt_kprintf("+----------+------+------+----+\n"); for (next = _container.head.next; next != &_container.head; next = next->next) { alarm = rt_list_entry(next, struct rt_alarm, list); rt_uint8_t flag_index = get_alarm_flag_index(alarm->flag); rt_kprintf("| %02d:%02d:%02d | %2d | %2s | %2d |\n", alarm->wktime.tm_hour, alarm->wktime.tm_min, alarm->wktime.tm_sec, alarm->wktime.tm_wday, _alarm_flag_tbl[flag_index].name, alarm->flag & RT_ALARM_STATE_START); } rt_kprintf("+----------+------+------+----+\n"); } MSH_CMD_EXPORT_ALIAS(rt_alarm_dump, list_alarm, list alarm info); /** \brief initialize alarm service system * * \param none * \return none */ int rt_alarm_system_init(void) { rt_thread_t tid; rt_list_init(&_container.head); rt_event_init(&_container.event, "alarmsvc", RT_IPC_FLAG_FIFO); rt_mutex_init(&_container.mutex, "alarmsvc", RT_IPC_FLAG_PRIO); tid = rt_thread_create("alarmsvc", rt_alarmsvc_thread_init, RT_NULL, RT_ALARM_STACK_SIZE, RT_ALARM_PRIORITY, RT_ALARM_TIMESLICE); if (tid != RT_NULL) rt_thread_startup(tid); return 0; } INIT_PREV_EXPORT(rt_alarm_system_init); #endif