3  * RTC subsystem, base class
15 #include <linux/rtc.h>
21 #include "rtc-core.h"
28 	struct rtc_device *rtc = to_rtc_device(dev);  in rtc_device_release()  local
30 	ida_simple_remove(&rtc_ida, rtc->id);  in rtc_device_release()
31 	mutex_destroy(&rtc->ops_lock);  in rtc_device_release()
32 	kfree(rtc);  in rtc_device_release()
36 /* Result of the last RTC to system clock attempt. */
39 /* IMPORTANT: the RTC only stores whole seconds. It is arbitrary
43  * in an rtc sync function, to read both xtime.tv_sec and
50 static void rtc_hctosys(struct rtc_device *rtc)  in rtc_hctosys()  argument
58 	err = rtc_read_time(rtc, &tm);  in rtc_hctosys()
60 		dev_err(rtc->dev.parent,  in rtc_hctosys()
76 	dev_info(rtc->dev.parent, "setting system clock to %ptR UTC (%lld)\n",  in rtc_hctosys()
86  * On suspend(), measure the delta between one RTC and the
94 	struct rtc_device	*rtc = to_rtc_device(dev);  in rtc_suspend()  local
102 	if (strcmp(dev_name(&rtc->dev), CONFIG_RTC_HCTOSYS_DEVICE) != 0)  in rtc_suspend()
105 	/* snapshot the current RTC and system time at suspend*/  in rtc_suspend()
106 	err = rtc_read_time(rtc, &tm);  in rtc_suspend()
108 		pr_debug("%s:  fail to read rtc time\n", dev_name(&rtc->dev));  in rtc_suspend()
119 	 * and rtc time stays close to constant.  in rtc_suspend()
139 	struct rtc_device	*rtc = to_rtc_device(dev);  in rtc_resume()  local
149 	if (strcmp(dev_name(&rtc->dev), CONFIG_RTC_HCTOSYS_DEVICE) != 0)  in rtc_resume()
152 	/* snapshot the current rtc and system time at resume */  in rtc_resume()
154 	err = rtc_read_time(rtc, &tm);  in rtc_resume()
156 		pr_debug("%s:  fail to read rtc time\n", dev_name(&rtc->dev));  in rtc_resume()
164 		pr_debug("%s:  time travel!\n", dev_name(&rtc->dev));  in rtc_resume()
168 	/* calculate the RTC time delta (sleep time)*/  in rtc_resume()
172 	 * Since these RTC suspend/resume handlers are not called  in rtc_resume()
196 	struct rtc_device *rtc;  in rtc_allocate_device()  local
198 	rtc = kzalloc(sizeof(*rtc), GFP_KERNEL);  in rtc_allocate_device()
199 	if (!rtc)  in rtc_allocate_device()
202 	device_initialize(&rtc->dev);  in rtc_allocate_device()
210 	rtc->set_offset_nsec = NSEC_PER_SEC + 5 * NSEC_PER_MSEC;  in rtc_allocate_device()
212 	rtc->irq_freq = 1;  in rtc_allocate_device()
213 	rtc->max_user_freq = 64;  in rtc_allocate_device()
214 	rtc->dev.class = rtc_class;  in rtc_allocate_device()
215 	rtc->dev.groups = rtc_get_dev_attribute_groups();  in rtc_allocate_device()
216 	rtc->dev.release = rtc_device_release;  in rtc_allocate_device()
218 	mutex_init(&rtc->ops_lock);  in rtc_allocate_device()
219 	spin_lock_init(&rtc->irq_lock);  in rtc_allocate_device()
220 	init_waitqueue_head(&rtc->irq_queue);  in rtc_allocate_device()
223 	timerqueue_init_head(&rtc->timerqueue);  in rtc_allocate_device()
224 	INIT_WORK(&rtc->irqwork, rtc_timer_do_work);  in rtc_allocate_device()
226 	rtc_timer_init(&rtc->aie_timer, rtc_aie_update_irq, rtc);  in rtc_allocate_device()
228 	rtc_timer_init(&rtc->uie_rtctimer, rtc_uie_update_irq, rtc);  in rtc_allocate_device()
230 	hrtimer_init(&rtc->pie_timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);  in rtc_allocate_device()
231 	rtc->pie_timer.function = rtc_pie_update_irq;  in rtc_allocate_device()
232 	rtc->pie_enabled = 0;  in rtc_allocate_device()
234 	set_bit(RTC_FEATURE_ALARM, rtc->features);  in rtc_allocate_device()
236 	return rtc;  in rtc_allocate_device()
244 		of_id = of_alias_get_id(dev->of_node, "rtc");  in rtc_device_get_id()
246 		of_id = of_alias_get_id(dev->parent->of_node, "rtc");  in rtc_device_get_id()
260 static void rtc_device_get_offset(struct rtc_device *rtc)  in rtc_device_get_offset()  argument
267 	 * If RTC driver did not implement the range of RTC hardware device,  in rtc_device_get_offset()
268 	 * then we can not expand the RTC range by adding or subtracting one  in rtc_device_get_offset()
271 	if (rtc->range_min == rtc->range_max)  in rtc_device_get_offset()
274 	ret = device_property_read_u32(rtc->dev.parent, "start-year",  in rtc_device_get_offset()
277 		rtc->start_secs = mktime64(start_year, 1, 1, 0, 0, 0);  in rtc_device_get_offset()
278 		rtc->set_start_time = true;  in rtc_device_get_offset()
282 	 * If user did not implement the start time for RTC driver, then no  in rtc_device_get_offset()
283 	 * need to expand the RTC range.  in rtc_device_get_offset()
285 	if (!rtc->set_start_time)  in rtc_device_get_offset()
288 	range_secs = rtc->range_max - rtc->range_min + 1;  in rtc_device_get_offset()
291 	 * If the start_secs is larger than the maximum seconds (rtc->range_max)  in rtc_device_get_offset()
292 	 * supported by RTC hardware or the maximum seconds of new expanded  in rtc_device_get_offset()
293 	 * range (start_secs + rtc->range_max - rtc->range_min) is less than  in rtc_device_get_offset()
294 	 * rtc->range_min, which means the minimum seconds (rtc->range_min) of  in rtc_device_get_offset()
295 	 * RTC hardware will be mapped to start_secs by adding one offset, so  in rtc_device_get_offset()
297 	 * rtc->offset_secs = rtc->start_secs - rtc->range_min;  in rtc_device_get_offset()
299 	 * If the start_secs is larger than the minimum seconds (rtc->range_min)  in rtc_device_get_offset()
300 	 * supported by RTC hardware, then there is one region is overlapped  in rtc_device_get_offset()
301 	 * between the original RTC hardware range and the new expanded range,  in rtc_device_get_offset()
303 	 * expanded range due to it is valid for RTC device. So the minimum  in rtc_device_get_offset()
304 	 * seconds of RTC hardware (rtc->range_min) should be mapped to  in rtc_device_get_offset()
305 	 * rtc->range_max + 1, then the offset seconds formula should be:  in rtc_device_get_offset()
306 	 * rtc->offset_secs = rtc->range_max - rtc->range_min + 1;  in rtc_device_get_offset()
308 	 * If the start_secs is less than the minimum seconds (rtc->range_min),  in rtc_device_get_offset()
310 	 * start_secs + rtc->range_max - rtc->range_min + 1, then the  in rtc_device_get_offset()
312 	 * rtc->offset_secs = -(rtc->range_max - rtc->range_min + 1);  in rtc_device_get_offset()
316 	if (rtc->start_secs > rtc->range_max ||  in rtc_device_get_offset()
317 	    rtc->start_secs + range_secs - 1 < rtc->range_min)  in rtc_device_get_offset()
318 		rtc->offset_secs = rtc->start_secs - rtc->range_min;  in rtc_device_get_offset()
319 	else if (rtc->start_secs > rtc->range_min)  in rtc_device_get_offset()
320 		rtc->offset_secs = range_secs;  in rtc_device_get_offset()
321 	else if (rtc->start_secs < rtc->range_min)  in rtc_device_get_offset()
322 		rtc->offset_secs = -range_secs;  in rtc_device_get_offset()
324 		rtc->offset_secs = 0;  in rtc_device_get_offset()
329 	struct rtc_device *rtc = data;  in devm_rtc_unregister_device()  local
331 	mutex_lock(&rtc->ops_lock);  in devm_rtc_unregister_device()
333 	 * Remove innards of this RTC, then disable it, before  in devm_rtc_unregister_device()
336 	rtc_proc_del_device(rtc);  in devm_rtc_unregister_device()
337 	cdev_device_del(&rtc->char_dev, &rtc->dev);  in devm_rtc_unregister_device()
338 	rtc->ops = NULL;  in devm_rtc_unregister_device()
339 	mutex_unlock(&rtc->ops_lock);  in devm_rtc_unregister_device()
344 	struct rtc_device *rtc = res;  in devm_rtc_release_device()  local
346 	put_device(&rtc->dev);  in devm_rtc_release_device()
351 	struct rtc_device *rtc;  in devm_rtc_allocate_device()  local
358 	rtc = rtc_allocate_device();  in devm_rtc_allocate_device()
359 	if (!rtc) {  in devm_rtc_allocate_device()
364 	rtc->id = id;  in devm_rtc_allocate_device()
365 	rtc->dev.parent = dev;  in devm_rtc_allocate_device()
366 	dev_set_name(&rtc->dev, "rtc%d", id);  in devm_rtc_allocate_device()
368 	err = devm_add_action_or_reset(dev, devm_rtc_release_device, rtc);  in devm_rtc_allocate_device()
372 	return rtc;  in devm_rtc_allocate_device()
376 int __devm_rtc_register_device(struct module *owner, struct rtc_device *rtc)  in __devm_rtc_register_device()  argument
381 	if (!rtc->ops) {  in __devm_rtc_register_device()
382 		dev_dbg(&rtc->dev, "no ops set\n");  in __devm_rtc_register_device()
386 	if (!rtc->ops->set_alarm)  in __devm_rtc_register_device()
387 		clear_bit(RTC_FEATURE_ALARM, rtc->features);  in __devm_rtc_register_device()
389 	rtc->owner = owner;  in __devm_rtc_register_device()
390 	rtc_device_get_offset(rtc);  in __devm_rtc_register_device()
393 	err = __rtc_read_alarm(rtc, &alrm);  in __devm_rtc_register_device()
395 		rtc_initialize_alarm(rtc, &alrm);  in __devm_rtc_register_device()
397 	rtc_dev_prepare(rtc);  in __devm_rtc_register_device()
399 	err = cdev_device_add(&rtc->char_dev, &rtc->dev);  in __devm_rtc_register_device()
401 		dev_warn(rtc->dev.parent, "failed to add char device %d:%d\n",  in __devm_rtc_register_device()
402 			 MAJOR(rtc->dev.devt), rtc->id);  in __devm_rtc_register_device()
404 		dev_dbg(rtc->dev.parent, "char device (%d:%d)\n",  in __devm_rtc_register_device()
405 			MAJOR(rtc->dev.devt), rtc->id);  in __devm_rtc_register_device()
407 	rtc_proc_add_device(rtc);  in __devm_rtc_register_device()
409 	dev_info(rtc->dev.parent, "registered as %s\n",  in __devm_rtc_register_device()
410 		 dev_name(&rtc->dev));  in __devm_rtc_register_device()
413 	if (!strcmp(dev_name(&rtc->dev), CONFIG_RTC_HCTOSYS_DEVICE))  in __devm_rtc_register_device()
414 		rtc_hctosys(rtc);  in __devm_rtc_register_device()
417 	return devm_add_action_or_reset(rtc->dev.parent,  in __devm_rtc_register_device()
418 					devm_rtc_unregister_device, rtc);  in __devm_rtc_register_device()
426  * @ops: the rtc operations structure
429  * @return a struct rtc on success, or an ERR_PTR on error
441 	struct rtc_device *rtc;  in devm_rtc_device_register()  local
444 	rtc = devm_rtc_allocate_device(dev);  in devm_rtc_device_register()
445 	if (IS_ERR(rtc))  in devm_rtc_device_register()
446 		return rtc;  in devm_rtc_device_register()
448 	rtc->ops = ops;  in devm_rtc_device_register()
450 	err = __devm_rtc_register_device(owner, rtc);  in devm_rtc_device_register()
454 	return rtc;  in devm_rtc_device_register()
460 	rtc_class = class_create(THIS_MODULE, "rtc");  in rtc_init()