2 * RTC subsystem, dev interface
4 * Copyright (C) 2005 Tower Technologies
5 * Author: Alessandro Zummo <a.zummo@towertech.it>
7 * based on arch/arm/common/rtctime.c
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2 as
11 * published by the Free Software Foundation.
14 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
16 #include <linux/module.h>
17 #include <linux/rtc.h>
18 #include <linux/sched.h>
21 static dev_t rtc_devt
;
23 #define RTC_DEV_MAX 16 /* 16 RTCs should be enough for everyone... */
25 static int rtc_dev_open(struct inode
*inode
, struct file
*file
)
28 struct rtc_device
*rtc
= container_of(inode
->i_cdev
,
29 struct rtc_device
, char_dev
);
30 const struct rtc_class_ops
*ops
= rtc
->ops
;
32 if (test_and_set_bit_lock(RTC_DEV_BUSY
, &rtc
->flags
))
35 file
->private_data
= rtc
;
37 err
= ops
->open
? ops
->open(rtc
->dev
.parent
) : 0;
39 spin_lock_irq(&rtc
->irq_lock
);
41 spin_unlock_irq(&rtc
->irq_lock
);
46 /* something has gone wrong */
47 clear_bit_unlock(RTC_DEV_BUSY
, &rtc
->flags
);
51 #ifdef CONFIG_RTC_INTF_DEV_UIE_EMUL
53 * Routine to poll RTC seconds field for change as often as possible,
54 * after first RTC_UIE use timer to reduce polling
56 static void rtc_uie_task(struct work_struct
*work
)
58 struct rtc_device
*rtc
=
59 container_of(work
, struct rtc_device
, uie_task
);
64 err
= rtc_read_time(rtc
, &tm
);
66 spin_lock_irq(&rtc
->irq_lock
);
67 if (rtc
->stop_uie_polling
|| err
) {
68 rtc
->uie_task_active
= 0;
69 } else if (rtc
->oldsecs
!= tm
.tm_sec
) {
70 num
= (tm
.tm_sec
+ 60 - rtc
->oldsecs
) % 60;
71 rtc
->oldsecs
= tm
.tm_sec
;
72 rtc
->uie_timer
.expires
= jiffies
+ HZ
- (HZ
/10);
73 rtc
->uie_timer_active
= 1;
74 rtc
->uie_task_active
= 0;
75 add_timer(&rtc
->uie_timer
);
76 } else if (schedule_work(&rtc
->uie_task
) == 0) {
77 rtc
->uie_task_active
= 0;
79 spin_unlock_irq(&rtc
->irq_lock
);
81 rtc_handle_legacy_irq(rtc
, num
, RTC_UF
);
83 static void rtc_uie_timer(unsigned long data
)
85 struct rtc_device
*rtc
= (struct rtc_device
*)data
;
88 spin_lock_irqsave(&rtc
->irq_lock
, flags
);
89 rtc
->uie_timer_active
= 0;
90 rtc
->uie_task_active
= 1;
91 if ((schedule_work(&rtc
->uie_task
) == 0))
92 rtc
->uie_task_active
= 0;
93 spin_unlock_irqrestore(&rtc
->irq_lock
, flags
);
96 static int clear_uie(struct rtc_device
*rtc
)
98 spin_lock_irq(&rtc
->irq_lock
);
99 if (rtc
->uie_irq_active
) {
100 rtc
->stop_uie_polling
= 1;
101 if (rtc
->uie_timer_active
) {
102 spin_unlock_irq(&rtc
->irq_lock
);
103 del_timer_sync(&rtc
->uie_timer
);
104 spin_lock_irq(&rtc
->irq_lock
);
105 rtc
->uie_timer_active
= 0;
107 if (rtc
->uie_task_active
) {
108 spin_unlock_irq(&rtc
->irq_lock
);
109 flush_scheduled_work();
110 spin_lock_irq(&rtc
->irq_lock
);
112 rtc
->uie_irq_active
= 0;
114 spin_unlock_irq(&rtc
->irq_lock
);
118 static int set_uie(struct rtc_device
*rtc
)
123 err
= rtc_read_time(rtc
, &tm
);
126 spin_lock_irq(&rtc
->irq_lock
);
127 if (!rtc
->uie_irq_active
) {
128 rtc
->uie_irq_active
= 1;
129 rtc
->stop_uie_polling
= 0;
130 rtc
->oldsecs
= tm
.tm_sec
;
131 rtc
->uie_task_active
= 1;
132 if (schedule_work(&rtc
->uie_task
) == 0)
133 rtc
->uie_task_active
= 0;
136 spin_unlock_irq(&rtc
->irq_lock
);
140 int rtc_dev_update_irq_enable_emul(struct rtc_device
*rtc
, unsigned int enabled
)
145 return clear_uie(rtc
);
147 EXPORT_SYMBOL(rtc_dev_update_irq_enable_emul
);
149 #endif /* CONFIG_RTC_INTF_DEV_UIE_EMUL */
152 rtc_dev_read(struct file
*file
, char __user
*buf
, size_t count
, loff_t
*ppos
)
154 struct rtc_device
*rtc
= file
->private_data
;
156 DECLARE_WAITQUEUE(wait
, current
);
160 if (count
!= sizeof(unsigned int) && count
< sizeof(unsigned long))
163 add_wait_queue(&rtc
->irq_queue
, &wait
);
165 __set_current_state(TASK_INTERRUPTIBLE
);
167 spin_lock_irq(&rtc
->irq_lock
);
168 data
= rtc
->irq_data
;
170 spin_unlock_irq(&rtc
->irq_lock
);
176 if (file
->f_flags
& O_NONBLOCK
) {
180 if (signal_pending(current
)) {
186 set_current_state(TASK_RUNNING
);
187 remove_wait_queue(&rtc
->irq_queue
, &wait
);
190 /* Check for any data updates */
191 if (rtc
->ops
->read_callback
)
192 data
= rtc
->ops
->read_callback(rtc
->dev
.parent
,
195 if (sizeof(int) != sizeof(long) &&
196 count
== sizeof(unsigned int))
197 ret
= put_user(data
, (unsigned int __user
*)buf
) ?:
198 sizeof(unsigned int);
200 ret
= put_user(data
, (unsigned long __user
*)buf
) ?:
201 sizeof(unsigned long);
206 static unsigned int rtc_dev_poll(struct file
*file
, poll_table
*wait
)
208 struct rtc_device
*rtc
= file
->private_data
;
211 poll_wait(file
, &rtc
->irq_queue
, wait
);
213 data
= rtc
->irq_data
;
215 return (data
!= 0) ? (POLLIN
| POLLRDNORM
) : 0;
218 static long rtc_dev_ioctl(struct file
*file
,
219 unsigned int cmd
, unsigned long arg
)
222 struct rtc_device
*rtc
= file
->private_data
;
223 const struct rtc_class_ops
*ops
= rtc
->ops
;
225 struct rtc_wkalrm alarm
;
226 void __user
*uarg
= (void __user
*) arg
;
228 err
= mutex_lock_interruptible(&rtc
->ops_lock
);
232 /* check that the calling task has appropriate permissions
233 * for certain ioctls. doing this check here is useful
234 * to avoid duplicate code in each driver.
239 if (!capable(CAP_SYS_TIME
))
244 if (arg
> rtc
->max_user_freq
&& !capable(CAP_SYS_RESOURCE
))
249 if (rtc
->irq_freq
> rtc
->max_user_freq
&&
250 !capable(CAP_SYS_RESOURCE
))
259 * Drivers *SHOULD NOT* provide ioctl implementations
260 * for these requests. Instead, provide methods to
261 * support the following code, so that the RTC's main
262 * features are accessible without using ioctls.
264 * RTC and alarm times will be in UTC, by preference,
265 * but dual-booting with MS-Windows implies RTCs must
266 * use the local wall clock time.
271 mutex_unlock(&rtc
->ops_lock
);
273 err
= rtc_read_alarm(rtc
, &alarm
);
277 if (copy_to_user(uarg
, &alarm
.time
, sizeof(tm
)))
282 mutex_unlock(&rtc
->ops_lock
);
284 if (copy_from_user(&alarm
.time
, uarg
, sizeof(tm
)))
289 alarm
.time
.tm_wday
= -1;
290 alarm
.time
.tm_yday
= -1;
291 alarm
.time
.tm_isdst
= -1;
293 /* RTC_ALM_SET alarms may be up to 24 hours in the future.
294 * Rather than expecting every RTC to implement "don't care"
295 * for day/month/year fields, just force the alarm to have
296 * the right values for those fields.
298 * RTC_WKALM_SET should be used instead. Not only does it
299 * eliminate the need for a separate RTC_AIE_ON call, it
300 * doesn't have the "alarm 23:59:59 in the future" race.
302 * NOTE: some legacy code may have used invalid fields as
303 * wildcards, exposing hardware "periodic alarm" capabilities.
304 * Not supported here.
309 err
= rtc_read_time(rtc
, &tm
);
312 now
= rtc_tm_to_time64(&tm
);
314 alarm
.time
.tm_mday
= tm
.tm_mday
;
315 alarm
.time
.tm_mon
= tm
.tm_mon
;
316 alarm
.time
.tm_year
= tm
.tm_year
;
317 err
= rtc_valid_tm(&alarm
.time
);
320 then
= rtc_tm_to_time64(&alarm
.time
);
322 /* alarm may need to wrap into tomorrow */
324 rtc_time64_to_tm(now
+ 24 * 60 * 60, &tm
);
325 alarm
.time
.tm_mday
= tm
.tm_mday
;
326 alarm
.time
.tm_mon
= tm
.tm_mon
;
327 alarm
.time
.tm_year
= tm
.tm_year
;
331 return rtc_set_alarm(rtc
, &alarm
);
334 mutex_unlock(&rtc
->ops_lock
);
336 err
= rtc_read_time(rtc
, &tm
);
340 if (copy_to_user(uarg
, &tm
, sizeof(tm
)))
345 mutex_unlock(&rtc
->ops_lock
);
347 if (copy_from_user(&tm
, uarg
, sizeof(tm
)))
350 return rtc_set_time(rtc
, &tm
);
353 err
= rtc_irq_set_state(rtc
, NULL
, 1);
357 err
= rtc_irq_set_state(rtc
, NULL
, 0);
361 mutex_unlock(&rtc
->ops_lock
);
362 return rtc_alarm_irq_enable(rtc
, 1);
365 mutex_unlock(&rtc
->ops_lock
);
366 return rtc_alarm_irq_enable(rtc
, 0);
369 mutex_unlock(&rtc
->ops_lock
);
370 return rtc_update_irq_enable(rtc
, 1);
373 mutex_unlock(&rtc
->ops_lock
);
374 return rtc_update_irq_enable(rtc
, 0);
377 err
= rtc_irq_set_freq(rtc
, NULL
, arg
);
381 err
= put_user(rtc
->irq_freq
, (unsigned long __user
*)uarg
);
385 mutex_unlock(&rtc
->ops_lock
);
386 if (copy_from_user(&alarm
, uarg
, sizeof(alarm
)))
389 return rtc_set_alarm(rtc
, &alarm
);
392 mutex_unlock(&rtc
->ops_lock
);
393 err
= rtc_read_alarm(rtc
, &alarm
);
397 if (copy_to_user(uarg
, &alarm
, sizeof(alarm
)))
402 /* Finally try the driver's ioctl interface */
404 err
= ops
->ioctl(rtc
->dev
.parent
, cmd
, arg
);
405 if (err
== -ENOIOCTLCMD
)
413 mutex_unlock(&rtc
->ops_lock
);
417 static int rtc_dev_fasync(int fd
, struct file
*file
, int on
)
419 struct rtc_device
*rtc
= file
->private_data
;
420 return fasync_helper(fd
, file
, on
, &rtc
->async_queue
);
423 static int rtc_dev_release(struct inode
*inode
, struct file
*file
)
425 struct rtc_device
*rtc
= file
->private_data
;
427 /* We shut down the repeating IRQs that userspace enabled,
428 * since nothing is listening to them.
429 * - Update (UIE) ... currently only managed through ioctls
430 * - Periodic (PIE) ... also used through rtc_*() interface calls
432 * Leave the alarm alone; it may be set to trigger a system wakeup
433 * later, or be used by kernel code, and is a one-shot event anyway.
436 /* Keep ioctl until all drivers are converted */
437 rtc_dev_ioctl(file
, RTC_UIE_OFF
, 0);
438 rtc_update_irq_enable(rtc
, 0);
439 rtc_irq_set_state(rtc
, NULL
, 0);
441 if (rtc
->ops
->release
)
442 rtc
->ops
->release(rtc
->dev
.parent
);
444 clear_bit_unlock(RTC_DEV_BUSY
, &rtc
->flags
);
448 static const struct file_operations rtc_dev_fops
= {
449 .owner
= THIS_MODULE
,
451 .read
= rtc_dev_read
,
452 .poll
= rtc_dev_poll
,
453 .unlocked_ioctl
= rtc_dev_ioctl
,
454 .open
= rtc_dev_open
,
455 .release
= rtc_dev_release
,
456 .fasync
= rtc_dev_fasync
,
459 /* insertion/removal hooks */
461 void rtc_dev_prepare(struct rtc_device
*rtc
)
466 if (rtc
->id
>= RTC_DEV_MAX
) {
467 dev_dbg(&rtc
->dev
, "%s: too many RTC devices\n", rtc
->name
);
471 rtc
->dev
.devt
= MKDEV(MAJOR(rtc_devt
), rtc
->id
);
473 #ifdef CONFIG_RTC_INTF_DEV_UIE_EMUL
474 INIT_WORK(&rtc
->uie_task
, rtc_uie_task
);
475 setup_timer(&rtc
->uie_timer
, rtc_uie_timer
, (unsigned long)rtc
);
478 cdev_init(&rtc
->char_dev
, &rtc_dev_fops
);
479 rtc
->char_dev
.owner
= rtc
->owner
;
480 rtc
->char_dev
.kobj
.parent
= &rtc
->dev
.kobj
;
483 void rtc_dev_add_device(struct rtc_device
*rtc
)
485 if (cdev_add(&rtc
->char_dev
, rtc
->dev
.devt
, 1))
486 dev_warn(&rtc
->dev
, "%s: failed to add char device %d:%d\n",
487 rtc
->name
, MAJOR(rtc_devt
), rtc
->id
);
489 dev_dbg(&rtc
->dev
, "%s: dev (%d:%d)\n", rtc
->name
,
490 MAJOR(rtc_devt
), rtc
->id
);
493 void rtc_dev_del_device(struct rtc_device
*rtc
)
496 cdev_del(&rtc
->char_dev
);
499 void __init
rtc_dev_init(void)
503 err
= alloc_chrdev_region(&rtc_devt
, 0, RTC_DEV_MAX
, "rtc");
505 pr_err("failed to allocate char dev region\n");
508 void __exit
rtc_dev_exit(void)
511 unregister_chrdev_region(rtc_devt
, RTC_DEV_MAX
);