RTC: Release mutex in error path of rtc_alarm_irq_enable
[linux-2.6-block.git] / drivers / rtc / rtc-dev.c
CommitLineData
e824290e
AZ
1/*
2 * RTC subsystem, dev interface
3 *
4 * Copyright (C) 2005 Tower Technologies
5 * Author: Alessandro Zummo <a.zummo@towertech.it>
6 *
7 * based on arch/arm/common/rtctime.c
8 *
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.
12*/
13
14#include <linux/module.h>
15#include <linux/rtc.h>
d43c36dc 16#include <linux/sched.h>
5726fb20 17#include "rtc-core.h"
e824290e 18
e824290e
AZ
19static dev_t rtc_devt;
20
21#define RTC_DEV_MAX 16 /* 16 RTCs should be enough for everyone... */
22
23static int rtc_dev_open(struct inode *inode, struct file *file)
24{
25 int err;
26 struct rtc_device *rtc = container_of(inode->i_cdev,
27 struct rtc_device, char_dev);
ff8371ac 28 const struct rtc_class_ops *ops = rtc->ops;
e824290e 29
b1c3c898
DB
30 if (test_and_set_bit_lock(RTC_DEV_BUSY, &rtc->flags))
31 return -EBUSY;
e824290e 32
ab6a2d70 33 file->private_data = rtc;
e824290e 34
cd966209 35 err = ops->open ? ops->open(rtc->dev.parent) : 0;
e824290e
AZ
36 if (err == 0) {
37 spin_lock_irq(&rtc->irq_lock);
38 rtc->irq_data = 0;
39 spin_unlock_irq(&rtc->irq_lock);
40
b1c3c898 41 return 0;
e824290e
AZ
42 }
43
8853c202 44 /* something has gone wrong */
372a302e 45 clear_bit_unlock(RTC_DEV_BUSY, &rtc->flags);
e824290e
AZ
46 return err;
47}
48
49
50static ssize_t
51rtc_dev_read(struct file *file, char __user *buf, size_t count, loff_t *ppos)
52{
88efe137 53 struct rtc_device *rtc = file->private_data;
e824290e
AZ
54
55 DECLARE_WAITQUEUE(wait, current);
56 unsigned long data;
57 ssize_t ret;
58
3418ff76 59 if (count != sizeof(unsigned int) && count < sizeof(unsigned long))
e824290e
AZ
60 return -EINVAL;
61
62 add_wait_queue(&rtc->irq_queue, &wait);
63 do {
64 __set_current_state(TASK_INTERRUPTIBLE);
65
66 spin_lock_irq(&rtc->irq_lock);
67 data = rtc->irq_data;
68 rtc->irq_data = 0;
69 spin_unlock_irq(&rtc->irq_lock);
70
71 if (data != 0) {
72 ret = 0;
73 break;
74 }
75 if (file->f_flags & O_NONBLOCK) {
76 ret = -EAGAIN;
77 break;
78 }
79 if (signal_pending(current)) {
80 ret = -ERESTARTSYS;
81 break;
82 }
83 schedule();
84 } while (1);
85 set_current_state(TASK_RUNNING);
86 remove_wait_queue(&rtc->irq_queue, &wait);
87
88 if (ret == 0) {
89 /* Check for any data updates */
90 if (rtc->ops->read_callback)
cd966209 91 data = rtc->ops->read_callback(rtc->dev.parent,
3418ff76
AN
92 data);
93
94 if (sizeof(int) != sizeof(long) &&
95 count == sizeof(unsigned int))
96 ret = put_user(data, (unsigned int __user *)buf) ?:
97 sizeof(unsigned int);
98 else
99 ret = put_user(data, (unsigned long __user *)buf) ?:
100 sizeof(unsigned long);
e824290e
AZ
101 }
102 return ret;
103}
104
105static unsigned int rtc_dev_poll(struct file *file, poll_table *wait)
106{
88efe137 107 struct rtc_device *rtc = file->private_data;
e824290e
AZ
108 unsigned long data;
109
110 poll_wait(file, &rtc->irq_queue, wait);
111
112 data = rtc->irq_data;
113
114 return (data != 0) ? (POLLIN | POLLRDNORM) : 0;
115}
116
5ad31a57 117static long rtc_dev_ioctl(struct file *file,
e824290e
AZ
118 unsigned int cmd, unsigned long arg)
119{
120 int err = 0;
ab6a2d70 121 struct rtc_device *rtc = file->private_data;
ff8371ac 122 const struct rtc_class_ops *ops = rtc->ops;
e824290e
AZ
123 struct rtc_time tm;
124 struct rtc_wkalrm alarm;
125 void __user *uarg = (void __user *) arg;
126
5ad31a57
DB
127 err = mutex_lock_interruptible(&rtc->ops_lock);
128 if (err)
b68bb263 129 return err;
5ad31a57 130
2601a464 131 /* check that the calling task has appropriate permissions
110d693d
AZ
132 * for certain ioctls. doing this check here is useful
133 * to avoid duplicate code in each driver.
134 */
135 switch (cmd) {
136 case RTC_EPOCH_SET:
137 case RTC_SET_TIME:
138 if (!capable(CAP_SYS_TIME))
5ad31a57 139 err = -EACCES;
110d693d
AZ
140 break;
141
142 case RTC_IRQP_SET:
143 if (arg > rtc->max_user_freq && !capable(CAP_SYS_RESOURCE))
5ad31a57 144 err = -EACCES;
110d693d
AZ
145 break;
146
147 case RTC_PIE_ON:
9d013d3b
BK
148 if (rtc->irq_freq > rtc->max_user_freq &&
149 !capable(CAP_SYS_RESOURCE))
5ad31a57 150 err = -EACCES;
110d693d
AZ
151 break;
152 }
153
5ad31a57
DB
154 if (err)
155 goto done;
156
ac54cd2b 157 /*
8a0bdfd7
DB
158 * Drivers *SHOULD NOT* provide ioctl implementations
159 * for these requests. Instead, provide methods to
160 * support the following code, so that the RTC's main
161 * features are accessible without using ioctls.
162 *
163 * RTC and alarm times will be in UTC, by preference,
164 * but dual-booting with MS-Windows implies RTCs must
165 * use the local wall clock time.
e824290e
AZ
166 */
167
168 switch (cmd) {
169 case RTC_ALM_READ:
5ad31a57
DB
170 mutex_unlock(&rtc->ops_lock);
171
ab6a2d70 172 err = rtc_read_alarm(rtc, &alarm);
e824290e
AZ
173 if (err < 0)
174 return err;
175
176 if (copy_to_user(uarg, &alarm.time, sizeof(tm)))
5ad31a57
DB
177 err = -EFAULT;
178 return err;
e824290e
AZ
179
180 case RTC_ALM_SET:
5ad31a57
DB
181 mutex_unlock(&rtc->ops_lock);
182
e824290e
AZ
183 if (copy_from_user(&alarm.time, uarg, sizeof(tm)))
184 return -EFAULT;
185
186 alarm.enabled = 0;
187 alarm.pending = 0;
e824290e
AZ
188 alarm.time.tm_wday = -1;
189 alarm.time.tm_yday = -1;
190 alarm.time.tm_isdst = -1;
f8245c26
DB
191
192 /* RTC_ALM_SET alarms may be up to 24 hours in the future.
193 * Rather than expecting every RTC to implement "don't care"
194 * for day/month/year fields, just force the alarm to have
195 * the right values for those fields.
196 *
197 * RTC_WKALM_SET should be used instead. Not only does it
198 * eliminate the need for a separate RTC_AIE_ON call, it
199 * doesn't have the "alarm 23:59:59 in the future" race.
200 *
201 * NOTE: some legacy code may have used invalid fields as
202 * wildcards, exposing hardware "periodic alarm" capabilities.
203 * Not supported here.
204 */
205 {
206 unsigned long now, then;
207
208 err = rtc_read_time(rtc, &tm);
209 if (err < 0)
210 return err;
211 rtc_tm_to_time(&tm, &now);
212
213 alarm.time.tm_mday = tm.tm_mday;
214 alarm.time.tm_mon = tm.tm_mon;
215 alarm.time.tm_year = tm.tm_year;
216 err = rtc_valid_tm(&alarm.time);
217 if (err < 0)
218 return err;
219 rtc_tm_to_time(&alarm.time, &then);
220
221 /* alarm may need to wrap into tomorrow */
222 if (then < now) {
223 rtc_time_to_tm(now + 24 * 60 * 60, &tm);
224 alarm.time.tm_mday = tm.tm_mday;
225 alarm.time.tm_mon = tm.tm_mon;
226 alarm.time.tm_year = tm.tm_year;
227 }
228 }
229
5ad31a57 230 return rtc_set_alarm(rtc, &alarm);
e824290e
AZ
231
232 case RTC_RD_TIME:
5ad31a57
DB
233 mutex_unlock(&rtc->ops_lock);
234
ab6a2d70 235 err = rtc_read_time(rtc, &tm);
e824290e
AZ
236 if (err < 0)
237 return err;
238
239 if (copy_to_user(uarg, &tm, sizeof(tm)))
5ad31a57
DB
240 err = -EFAULT;
241 return err;
e824290e
AZ
242
243 case RTC_SET_TIME:
5ad31a57
DB
244 mutex_unlock(&rtc->ops_lock);
245
e824290e
AZ
246 if (copy_from_user(&tm, uarg, sizeof(tm)))
247 return -EFAULT;
248
5ad31a57 249 return rtc_set_time(rtc, &tm);
2601a464 250
d691eb90
AZ
251 case RTC_PIE_ON:
252 err = rtc_irq_set_state(rtc, NULL, 1);
253 break;
254
255 case RTC_PIE_OFF:
256 err = rtc_irq_set_state(rtc, NULL, 0);
2601a464
DB
257 break;
258
099e6576
AZ
259 case RTC_AIE_ON:
260 mutex_unlock(&rtc->ops_lock);
261 return rtc_alarm_irq_enable(rtc, 1);
262
263 case RTC_AIE_OFF:
264 mutex_unlock(&rtc->ops_lock);
265 return rtc_alarm_irq_enable(rtc, 0);
266
267 case RTC_UIE_ON:
268 mutex_unlock(&rtc->ops_lock);
269 return rtc_update_irq_enable(rtc, 1);
270
271 case RTC_UIE_OFF:
272 mutex_unlock(&rtc->ops_lock);
273 return rtc_update_irq_enable(rtc, 0);
274
2601a464 275 case RTC_IRQP_SET:
d691eb90
AZ
276 err = rtc_irq_set_freq(rtc, NULL, arg);
277 break;
278
279 case RTC_IRQP_READ:
280 err = put_user(rtc->irq_freq, (unsigned long __user *)uarg);
2601a464
DB
281 break;
282
e824290e
AZ
283#if 0
284 case RTC_EPOCH_SET:
285#ifndef rtc_epoch
286 /*
287 * There were no RTC clocks before 1900.
288 */
289 if (arg < 1900) {
290 err = -EINVAL;
291 break;
292 }
e824290e
AZ
293 rtc_epoch = arg;
294 err = 0;
295#endif
296 break;
297
298 case RTC_EPOCH_READ:
299 err = put_user(rtc_epoch, (unsigned long __user *)uarg);
300 break;
301#endif
302 case RTC_WKALM_SET:
5ad31a57 303 mutex_unlock(&rtc->ops_lock);
e824290e
AZ
304 if (copy_from_user(&alarm, uarg, sizeof(alarm)))
305 return -EFAULT;
306
5ad31a57 307 return rtc_set_alarm(rtc, &alarm);
e824290e
AZ
308
309 case RTC_WKALM_RD:
5ad31a57 310 mutex_unlock(&rtc->ops_lock);
ab6a2d70 311 err = rtc_read_alarm(rtc, &alarm);
e824290e
AZ
312 if (err < 0)
313 return err;
314
315 if (copy_to_user(uarg, &alarm, sizeof(alarm)))
5ad31a57
DB
316 err = -EFAULT;
317 return err;
e824290e
AZ
318
319 default:
ac54cd2b
JS
320 /* Finally try the driver's ioctl interface */
321 if (ops->ioctl) {
322 err = ops->ioctl(rtc->dev.parent, cmd, arg);
323 if (err == -ENOIOCTLCMD)
324 err = -ENOTTY;
325 }
e824290e
AZ
326 break;
327 }
328
5ad31a57
DB
329done:
330 mutex_unlock(&rtc->ops_lock);
e824290e
AZ
331 return err;
332}
333
2e4a75cd
MS
334static int rtc_dev_fasync(int fd, struct file *file, int on)
335{
336 struct rtc_device *rtc = file->private_data;
337 return fasync_helper(fd, file, on, &rtc->async_queue);
338}
339
e824290e
AZ
340static int rtc_dev_release(struct inode *inode, struct file *file)
341{
88efe137 342 struct rtc_device *rtc = file->private_data;
e824290e 343
743e6a50
DB
344 /* We shut down the repeating IRQs that userspace enabled,
345 * since nothing is listening to them.
346 * - Update (UIE) ... currently only managed through ioctls
347 * - Periodic (PIE) ... also used through rtc_*() interface calls
348 *
349 * Leave the alarm alone; it may be set to trigger a system wakeup
350 * later, or be used by kernel code, and is a one-shot event anyway.
351 */
099e6576
AZ
352
353 /* Keep ioctl until all drivers are converted */
743e6a50 354 rtc_dev_ioctl(file, RTC_UIE_OFF, 0);
099e6576 355 rtc_update_irq_enable(rtc, 0);
5cdc98b8
TJ
356 rtc_irq_set_state(rtc, NULL, 0);
357
e824290e 358 if (rtc->ops->release)
cd966209 359 rtc->ops->release(rtc->dev.parent);
e824290e 360
372a302e 361 clear_bit_unlock(RTC_DEV_BUSY, &rtc->flags);
e824290e
AZ
362 return 0;
363}
364
d54b1fdb 365static const struct file_operations rtc_dev_fops = {
e824290e
AZ
366 .owner = THIS_MODULE,
367 .llseek = no_llseek,
368 .read = rtc_dev_read,
369 .poll = rtc_dev_poll,
5ad31a57 370 .unlocked_ioctl = rtc_dev_ioctl,
e824290e
AZ
371 .open = rtc_dev_open,
372 .release = rtc_dev_release,
373 .fasync = rtc_dev_fasync,
374};
375
376/* insertion/removal hooks */
377
cb3a58d2 378void rtc_dev_prepare(struct rtc_device *rtc)
e824290e 379{
5726fb20
DB
380 if (!rtc_devt)
381 return;
e824290e
AZ
382
383 if (rtc->id >= RTC_DEV_MAX) {
5726fb20
DB
384 pr_debug("%s: too many RTC devices\n", rtc->name);
385 return;
e824290e
AZ
386 }
387
cd966209 388 rtc->dev.devt = MKDEV(MAJOR(rtc_devt), rtc->id);
5726fb20 389
e824290e
AZ
390 cdev_init(&rtc->char_dev, &rtc_dev_fops);
391 rtc->char_dev.owner = rtc->owner;
cb3a58d2 392}
e824290e 393
cb3a58d2
DB
394void rtc_dev_add_device(struct rtc_device *rtc)
395{
cd966209 396 if (cdev_add(&rtc->char_dev, rtc->dev.devt, 1))
5726fb20
DB
397 printk(KERN_WARNING "%s: failed to add char device %d:%d\n",
398 rtc->name, MAJOR(rtc_devt), rtc->id);
399 else
400 pr_debug("%s: dev (%d:%d)\n", rtc->name,
e824290e 401 MAJOR(rtc_devt), rtc->id);
e824290e
AZ
402}
403
5726fb20 404void rtc_dev_del_device(struct rtc_device *rtc)
e824290e 405{
cd966209 406 if (rtc->dev.devt)
e824290e 407 cdev_del(&rtc->char_dev);
e824290e
AZ
408}
409
5726fb20 410void __init rtc_dev_init(void)
e824290e
AZ
411{
412 int err;
413
e824290e 414 err = alloc_chrdev_region(&rtc_devt, 0, RTC_DEV_MAX, "rtc");
5726fb20 415 if (err < 0)
e824290e
AZ
416 printk(KERN_ERR "%s: failed to allocate char dev region\n",
417 __FILE__);
e824290e
AZ
418}
419
5726fb20 420void __exit rtc_dev_exit(void)
e824290e 421{
5726fb20
DB
422 if (rtc_devt)
423 unregister_chrdev_region(rtc_devt, RTC_DEV_MAX);
e824290e 424}