usb: gadget: udc: core: Document the relation between usb_ep_queue() and completion...
[linux/fpc-iii.git] / drivers / rtc / rtc-ds1374.c
blob38a2e9e684df43898086ebaa119cb7752d981794
1 /*
2 * RTC client/driver for the Maxim/Dallas DS1374 Real-Time Clock over I2C
4 * Based on code by Randy Vinson <rvinson@mvista.com>,
5 * which was based on the m41t00.c by Mark Greer <mgreer@mvista.com>.
7 * Copyright (C) 2014 Rose Technology
8 * Copyright (C) 2006-2007 Freescale Semiconductor
10 * 2005 (c) MontaVista Software, Inc. This file is licensed under
11 * the terms of the GNU General Public License version 2. This program
12 * is licensed "as is" without any warranty of any kind, whether express
13 * or implied.
16 * It would be more efficient to use i2c msgs/i2c_transfer directly but, as
17 * recommened in .../Documentation/i2c/writing-clients section
18 * "Sending and receiving", using SMBus level communication is preferred.
21 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
23 #include <linux/kernel.h>
24 #include <linux/module.h>
25 #include <linux/interrupt.h>
26 #include <linux/i2c.h>
27 #include <linux/rtc.h>
28 #include <linux/bcd.h>
29 #include <linux/workqueue.h>
30 #include <linux/slab.h>
31 #include <linux/pm.h>
32 #ifdef CONFIG_RTC_DRV_DS1374_WDT
33 #include <linux/fs.h>
34 #include <linux/ioctl.h>
35 #include <linux/miscdevice.h>
36 #include <linux/reboot.h>
37 #include <linux/watchdog.h>
38 #endif
40 #define DS1374_REG_TOD0 0x00 /* Time of Day */
41 #define DS1374_REG_TOD1 0x01
42 #define DS1374_REG_TOD2 0x02
43 #define DS1374_REG_TOD3 0x03
44 #define DS1374_REG_WDALM0 0x04 /* Watchdog/Alarm */
45 #define DS1374_REG_WDALM1 0x05
46 #define DS1374_REG_WDALM2 0x06
47 #define DS1374_REG_CR 0x07 /* Control */
48 #define DS1374_REG_CR_AIE 0x01 /* Alarm Int. Enable */
49 #define DS1374_REG_CR_WDALM 0x20 /* 1=Watchdog, 0=Alarm */
50 #define DS1374_REG_CR_WACE 0x40 /* WD/Alarm counter enable */
51 #define DS1374_REG_SR 0x08 /* Status */
52 #define DS1374_REG_SR_OSF 0x80 /* Oscillator Stop Flag */
53 #define DS1374_REG_SR_AF 0x01 /* Alarm Flag */
54 #define DS1374_REG_TCR 0x09 /* Trickle Charge */
56 static const struct i2c_device_id ds1374_id[] = {
57 { "ds1374", 0 },
58 { }
60 MODULE_DEVICE_TABLE(i2c, ds1374_id);
62 #ifdef CONFIG_OF
63 static const struct of_device_id ds1374_of_match[] = {
64 { .compatible = "dallas,ds1374" },
65 { }
67 MODULE_DEVICE_TABLE(of, ds1374_of_match);
68 #endif
70 struct ds1374 {
71 struct i2c_client *client;
72 struct rtc_device *rtc;
73 struct work_struct work;
75 /* The mutex protects alarm operations, and prevents a race
76 * between the enable_irq() in the workqueue and the free_irq()
77 * in the remove function.
79 struct mutex mutex;
80 int exiting;
83 static struct i2c_driver ds1374_driver;
85 static int ds1374_read_rtc(struct i2c_client *client, u32 *time,
86 int reg, int nbytes)
88 u8 buf[4];
89 int ret;
90 int i;
92 if (WARN_ON(nbytes > 4))
93 return -EINVAL;
95 ret = i2c_smbus_read_i2c_block_data(client, reg, nbytes, buf);
97 if (ret < 0)
98 return ret;
99 if (ret < nbytes)
100 return -EIO;
102 for (i = nbytes - 1, *time = 0; i >= 0; i--)
103 *time = (*time << 8) | buf[i];
105 return 0;
108 static int ds1374_write_rtc(struct i2c_client *client, u32 time,
109 int reg, int nbytes)
111 u8 buf[4];
112 int i;
114 if (nbytes > 4) {
115 WARN_ON(1);
116 return -EINVAL;
119 for (i = 0; i < nbytes; i++) {
120 buf[i] = time & 0xff;
121 time >>= 8;
124 return i2c_smbus_write_i2c_block_data(client, reg, nbytes, buf);
127 static int ds1374_check_rtc_status(struct i2c_client *client)
129 int ret = 0;
130 int control, stat;
132 stat = i2c_smbus_read_byte_data(client, DS1374_REG_SR);
133 if (stat < 0)
134 return stat;
136 if (stat & DS1374_REG_SR_OSF)
137 dev_warn(&client->dev,
138 "oscillator discontinuity flagged, time unreliable\n");
140 stat &= ~(DS1374_REG_SR_OSF | DS1374_REG_SR_AF);
142 ret = i2c_smbus_write_byte_data(client, DS1374_REG_SR, stat);
143 if (ret < 0)
144 return ret;
146 /* If the alarm is pending, clear it before requesting
147 * the interrupt, so an interrupt event isn't reported
148 * before everything is initialized.
151 control = i2c_smbus_read_byte_data(client, DS1374_REG_CR);
152 if (control < 0)
153 return control;
155 control &= ~(DS1374_REG_CR_WACE | DS1374_REG_CR_AIE);
156 return i2c_smbus_write_byte_data(client, DS1374_REG_CR, control);
159 static int ds1374_read_time(struct device *dev, struct rtc_time *time)
161 struct i2c_client *client = to_i2c_client(dev);
162 u32 itime;
163 int ret;
165 ret = ds1374_read_rtc(client, &itime, DS1374_REG_TOD0, 4);
166 if (!ret)
167 rtc_time_to_tm(itime, time);
169 return ret;
172 static int ds1374_set_time(struct device *dev, struct rtc_time *time)
174 struct i2c_client *client = to_i2c_client(dev);
175 unsigned long itime;
177 rtc_tm_to_time(time, &itime);
178 return ds1374_write_rtc(client, itime, DS1374_REG_TOD0, 4);
181 #ifndef CONFIG_RTC_DRV_DS1374_WDT
182 /* The ds1374 has a decrementer for an alarm, rather than a comparator.
183 * If the time of day is changed, then the alarm will need to be
184 * reset.
186 static int ds1374_read_alarm(struct device *dev, struct rtc_wkalrm *alarm)
188 struct i2c_client *client = to_i2c_client(dev);
189 struct ds1374 *ds1374 = i2c_get_clientdata(client);
190 u32 now, cur_alarm;
191 int cr, sr;
192 int ret = 0;
194 if (client->irq <= 0)
195 return -EINVAL;
197 mutex_lock(&ds1374->mutex);
199 cr = ret = i2c_smbus_read_byte_data(client, DS1374_REG_CR);
200 if (ret < 0)
201 goto out;
203 sr = ret = i2c_smbus_read_byte_data(client, DS1374_REG_SR);
204 if (ret < 0)
205 goto out;
207 ret = ds1374_read_rtc(client, &now, DS1374_REG_TOD0, 4);
208 if (ret)
209 goto out;
211 ret = ds1374_read_rtc(client, &cur_alarm, DS1374_REG_WDALM0, 3);
212 if (ret)
213 goto out;
215 rtc_time_to_tm(now + cur_alarm, &alarm->time);
216 alarm->enabled = !!(cr & DS1374_REG_CR_WACE);
217 alarm->pending = !!(sr & DS1374_REG_SR_AF);
219 out:
220 mutex_unlock(&ds1374->mutex);
221 return ret;
224 static int ds1374_set_alarm(struct device *dev, struct rtc_wkalrm *alarm)
226 struct i2c_client *client = to_i2c_client(dev);
227 struct ds1374 *ds1374 = i2c_get_clientdata(client);
228 struct rtc_time now;
229 unsigned long new_alarm, itime;
230 int cr;
231 int ret = 0;
233 if (client->irq <= 0)
234 return -EINVAL;
236 ret = ds1374_read_time(dev, &now);
237 if (ret < 0)
238 return ret;
240 rtc_tm_to_time(&alarm->time, &new_alarm);
241 rtc_tm_to_time(&now, &itime);
243 /* This can happen due to races, in addition to dates that are
244 * truly in the past. To avoid requiring the caller to check for
245 * races, dates in the past are assumed to be in the recent past
246 * (i.e. not something that we'd rather the caller know about via
247 * an error), and the alarm is set to go off as soon as possible.
249 if (time_before_eq(new_alarm, itime))
250 new_alarm = 1;
251 else
252 new_alarm -= itime;
254 mutex_lock(&ds1374->mutex);
256 ret = cr = i2c_smbus_read_byte_data(client, DS1374_REG_CR);
257 if (ret < 0)
258 goto out;
260 /* Disable any existing alarm before setting the new one
261 * (or lack thereof). */
262 cr &= ~DS1374_REG_CR_WACE;
264 ret = i2c_smbus_write_byte_data(client, DS1374_REG_CR, cr);
265 if (ret < 0)
266 goto out;
268 ret = ds1374_write_rtc(client, new_alarm, DS1374_REG_WDALM0, 3);
269 if (ret)
270 goto out;
272 if (alarm->enabled) {
273 cr |= DS1374_REG_CR_WACE | DS1374_REG_CR_AIE;
274 cr &= ~DS1374_REG_CR_WDALM;
276 ret = i2c_smbus_write_byte_data(client, DS1374_REG_CR, cr);
279 out:
280 mutex_unlock(&ds1374->mutex);
281 return ret;
283 #endif
285 static irqreturn_t ds1374_irq(int irq, void *dev_id)
287 struct i2c_client *client = dev_id;
288 struct ds1374 *ds1374 = i2c_get_clientdata(client);
290 disable_irq_nosync(irq);
291 schedule_work(&ds1374->work);
292 return IRQ_HANDLED;
295 static void ds1374_work(struct work_struct *work)
297 struct ds1374 *ds1374 = container_of(work, struct ds1374, work);
298 struct i2c_client *client = ds1374->client;
299 int stat, control;
301 mutex_lock(&ds1374->mutex);
303 stat = i2c_smbus_read_byte_data(client, DS1374_REG_SR);
304 if (stat < 0)
305 goto unlock;
307 if (stat & DS1374_REG_SR_AF) {
308 stat &= ~DS1374_REG_SR_AF;
309 i2c_smbus_write_byte_data(client, DS1374_REG_SR, stat);
311 control = i2c_smbus_read_byte_data(client, DS1374_REG_CR);
312 if (control < 0)
313 goto out;
315 control &= ~(DS1374_REG_CR_WACE | DS1374_REG_CR_AIE);
316 i2c_smbus_write_byte_data(client, DS1374_REG_CR, control);
318 rtc_update_irq(ds1374->rtc, 1, RTC_AF | RTC_IRQF);
321 out:
322 if (!ds1374->exiting)
323 enable_irq(client->irq);
324 unlock:
325 mutex_unlock(&ds1374->mutex);
328 #ifndef CONFIG_RTC_DRV_DS1374_WDT
329 static int ds1374_alarm_irq_enable(struct device *dev, unsigned int enabled)
331 struct i2c_client *client = to_i2c_client(dev);
332 struct ds1374 *ds1374 = i2c_get_clientdata(client);
333 int ret;
335 mutex_lock(&ds1374->mutex);
337 ret = i2c_smbus_read_byte_data(client, DS1374_REG_CR);
338 if (ret < 0)
339 goto out;
341 if (enabled) {
342 ret |= DS1374_REG_CR_WACE | DS1374_REG_CR_AIE;
343 ret &= ~DS1374_REG_CR_WDALM;
344 } else {
345 ret &= ~DS1374_REG_CR_WACE;
347 ret = i2c_smbus_write_byte_data(client, DS1374_REG_CR, ret);
349 out:
350 mutex_unlock(&ds1374->mutex);
351 return ret;
353 #endif
355 static const struct rtc_class_ops ds1374_rtc_ops = {
356 .read_time = ds1374_read_time,
357 .set_time = ds1374_set_time,
358 #ifndef CONFIG_RTC_DRV_DS1374_WDT
359 .read_alarm = ds1374_read_alarm,
360 .set_alarm = ds1374_set_alarm,
361 .alarm_irq_enable = ds1374_alarm_irq_enable,
362 #endif
365 #ifdef CONFIG_RTC_DRV_DS1374_WDT
367 *****************************************************************************
369 * Watchdog Driver
371 *****************************************************************************
373 static struct i2c_client *save_client;
374 /* Default margin */
375 #define WD_TIMO 131762
377 #define DRV_NAME "DS1374 Watchdog"
379 static int wdt_margin = WD_TIMO;
380 static unsigned long wdt_is_open;
381 module_param(wdt_margin, int, 0);
382 MODULE_PARM_DESC(wdt_margin, "Watchdog timeout in seconds (default 32s)");
384 static const struct watchdog_info ds1374_wdt_info = {
385 .identity = "DS1374 WTD",
386 .options = WDIOF_SETTIMEOUT | WDIOF_KEEPALIVEPING |
387 WDIOF_MAGICCLOSE,
390 static int ds1374_wdt_settimeout(unsigned int timeout)
392 int ret = -ENOIOCTLCMD;
393 int cr;
395 ret = cr = i2c_smbus_read_byte_data(save_client, DS1374_REG_CR);
396 if (ret < 0)
397 goto out;
399 /* Disable any existing watchdog/alarm before setting the new one */
400 cr &= ~DS1374_REG_CR_WACE;
402 ret = i2c_smbus_write_byte_data(save_client, DS1374_REG_CR, cr);
403 if (ret < 0)
404 goto out;
406 /* Set new watchdog time */
407 ret = ds1374_write_rtc(save_client, timeout, DS1374_REG_WDALM0, 3);
408 if (ret) {
409 pr_info("couldn't set new watchdog time\n");
410 goto out;
413 /* Enable watchdog timer */
414 cr |= DS1374_REG_CR_WACE | DS1374_REG_CR_WDALM;
415 cr &= ~DS1374_REG_CR_AIE;
417 ret = i2c_smbus_write_byte_data(save_client, DS1374_REG_CR, cr);
418 if (ret < 0)
419 goto out;
421 return 0;
422 out:
423 return ret;
428 * Reload the watchdog timer. (ie, pat the watchdog)
430 static void ds1374_wdt_ping(void)
432 u32 val;
433 int ret = 0;
435 ret = ds1374_read_rtc(save_client, &val, DS1374_REG_WDALM0, 3);
436 if (ret)
437 pr_info("WD TICK FAIL!!!!!!!!!! %i\n", ret);
440 static void ds1374_wdt_disable(void)
442 int ret = -ENOIOCTLCMD;
443 int cr;
445 cr = i2c_smbus_read_byte_data(save_client, DS1374_REG_CR);
446 /* Disable watchdog timer */
447 cr &= ~DS1374_REG_CR_WACE;
449 ret = i2c_smbus_write_byte_data(save_client, DS1374_REG_CR, cr);
453 * Watchdog device is opened, and watchdog starts running.
455 static int ds1374_wdt_open(struct inode *inode, struct file *file)
457 struct ds1374 *ds1374 = i2c_get_clientdata(save_client);
459 if (MINOR(inode->i_rdev) == WATCHDOG_MINOR) {
460 mutex_lock(&ds1374->mutex);
461 if (test_and_set_bit(0, &wdt_is_open)) {
462 mutex_unlock(&ds1374->mutex);
463 return -EBUSY;
466 * Activate
468 wdt_is_open = 1;
469 mutex_unlock(&ds1374->mutex);
470 return nonseekable_open(inode, file);
472 return -ENODEV;
476 * Close the watchdog device.
478 static int ds1374_wdt_release(struct inode *inode, struct file *file)
480 if (MINOR(inode->i_rdev) == WATCHDOG_MINOR)
481 clear_bit(0, &wdt_is_open);
483 return 0;
487 * Pat the watchdog whenever device is written to.
489 static ssize_t ds1374_wdt_write(struct file *file, const char __user *data,
490 size_t len, loff_t *ppos)
492 if (len) {
493 ds1374_wdt_ping();
494 return 1;
496 return 0;
499 static ssize_t ds1374_wdt_read(struct file *file, char __user *data,
500 size_t len, loff_t *ppos)
502 return 0;
506 * Handle commands from user-space.
508 static long ds1374_wdt_ioctl(struct file *file, unsigned int cmd,
509 unsigned long arg)
511 int new_margin, options;
513 switch (cmd) {
514 case WDIOC_GETSUPPORT:
515 return copy_to_user((struct watchdog_info __user *)arg,
516 &ds1374_wdt_info, sizeof(ds1374_wdt_info)) ? -EFAULT : 0;
518 case WDIOC_GETSTATUS:
519 case WDIOC_GETBOOTSTATUS:
520 return put_user(0, (int __user *)arg);
521 case WDIOC_KEEPALIVE:
522 ds1374_wdt_ping();
523 return 0;
524 case WDIOC_SETTIMEOUT:
525 if (get_user(new_margin, (int __user *)arg))
526 return -EFAULT;
528 /* the hardware's tick rate is 4096 Hz, so
529 * the counter value needs to be scaled accordingly
531 new_margin <<= 12;
532 if (new_margin < 1 || new_margin > 16777216)
533 return -EINVAL;
535 wdt_margin = new_margin;
536 ds1374_wdt_settimeout(new_margin);
537 ds1374_wdt_ping();
538 /* fallthrough */
539 case WDIOC_GETTIMEOUT:
540 /* when returning ... inverse is true */
541 return put_user((wdt_margin >> 12), (int __user *)arg);
542 case WDIOC_SETOPTIONS:
543 if (copy_from_user(&options, (int __user *)arg, sizeof(int)))
544 return -EFAULT;
546 if (options & WDIOS_DISABLECARD) {
547 pr_info("disable watchdog\n");
548 ds1374_wdt_disable();
549 return 0;
552 if (options & WDIOS_ENABLECARD) {
553 pr_info("enable watchdog\n");
554 ds1374_wdt_settimeout(wdt_margin);
555 ds1374_wdt_ping();
556 return 0;
558 return -EINVAL;
560 return -ENOTTY;
563 static long ds1374_wdt_unlocked_ioctl(struct file *file, unsigned int cmd,
564 unsigned long arg)
566 int ret;
567 struct ds1374 *ds1374 = i2c_get_clientdata(save_client);
569 mutex_lock(&ds1374->mutex);
570 ret = ds1374_wdt_ioctl(file, cmd, arg);
571 mutex_unlock(&ds1374->mutex);
573 return ret;
576 static int ds1374_wdt_notify_sys(struct notifier_block *this,
577 unsigned long code, void *unused)
579 if (code == SYS_DOWN || code == SYS_HALT)
580 /* Disable Watchdog */
581 ds1374_wdt_disable();
582 return NOTIFY_DONE;
585 static const struct file_operations ds1374_wdt_fops = {
586 .owner = THIS_MODULE,
587 .read = ds1374_wdt_read,
588 .unlocked_ioctl = ds1374_wdt_unlocked_ioctl,
589 .write = ds1374_wdt_write,
590 .open = ds1374_wdt_open,
591 .release = ds1374_wdt_release,
592 .llseek = no_llseek,
595 static struct miscdevice ds1374_miscdev = {
596 .minor = WATCHDOG_MINOR,
597 .name = "watchdog",
598 .fops = &ds1374_wdt_fops,
601 static struct notifier_block ds1374_wdt_notifier = {
602 .notifier_call = ds1374_wdt_notify_sys,
605 #endif /*CONFIG_RTC_DRV_DS1374_WDT*/
607 *****************************************************************************
609 * Driver Interface
611 *****************************************************************************
613 static int ds1374_probe(struct i2c_client *client,
614 const struct i2c_device_id *id)
616 struct ds1374 *ds1374;
617 int ret;
619 ds1374 = devm_kzalloc(&client->dev, sizeof(struct ds1374), GFP_KERNEL);
620 if (!ds1374)
621 return -ENOMEM;
623 ds1374->client = client;
624 i2c_set_clientdata(client, ds1374);
626 INIT_WORK(&ds1374->work, ds1374_work);
627 mutex_init(&ds1374->mutex);
629 ret = ds1374_check_rtc_status(client);
630 if (ret)
631 return ret;
633 if (client->irq > 0) {
634 ret = devm_request_irq(&client->dev, client->irq, ds1374_irq, 0,
635 "ds1374", client);
636 if (ret) {
637 dev_err(&client->dev, "unable to request IRQ\n");
638 return ret;
641 device_set_wakeup_capable(&client->dev, 1);
644 ds1374->rtc = devm_rtc_device_register(&client->dev, client->name,
645 &ds1374_rtc_ops, THIS_MODULE);
646 if (IS_ERR(ds1374->rtc)) {
647 dev_err(&client->dev, "unable to register the class device\n");
648 return PTR_ERR(ds1374->rtc);
651 #ifdef CONFIG_RTC_DRV_DS1374_WDT
652 save_client = client;
653 ret = misc_register(&ds1374_miscdev);
654 if (ret)
655 return ret;
656 ret = register_reboot_notifier(&ds1374_wdt_notifier);
657 if (ret) {
658 misc_deregister(&ds1374_miscdev);
659 return ret;
661 ds1374_wdt_settimeout(131072);
662 #endif
664 return 0;
667 static int ds1374_remove(struct i2c_client *client)
669 struct ds1374 *ds1374 = i2c_get_clientdata(client);
670 #ifdef CONFIG_RTC_DRV_DS1374_WDT
671 misc_deregister(&ds1374_miscdev);
672 ds1374_miscdev.parent = NULL;
673 unregister_reboot_notifier(&ds1374_wdt_notifier);
674 #endif
676 if (client->irq > 0) {
677 mutex_lock(&ds1374->mutex);
678 ds1374->exiting = 1;
679 mutex_unlock(&ds1374->mutex);
681 devm_free_irq(&client->dev, client->irq, client);
682 cancel_work_sync(&ds1374->work);
685 return 0;
688 #ifdef CONFIG_PM_SLEEP
689 static int ds1374_suspend(struct device *dev)
691 struct i2c_client *client = to_i2c_client(dev);
693 if (client->irq > 0 && device_may_wakeup(&client->dev))
694 enable_irq_wake(client->irq);
695 return 0;
698 static int ds1374_resume(struct device *dev)
700 struct i2c_client *client = to_i2c_client(dev);
702 if (client->irq > 0 && device_may_wakeup(&client->dev))
703 disable_irq_wake(client->irq);
704 return 0;
706 #endif
708 static SIMPLE_DEV_PM_OPS(ds1374_pm, ds1374_suspend, ds1374_resume);
710 static struct i2c_driver ds1374_driver = {
711 .driver = {
712 .name = "rtc-ds1374",
713 .of_match_table = of_match_ptr(ds1374_of_match),
714 .pm = &ds1374_pm,
716 .probe = ds1374_probe,
717 .remove = ds1374_remove,
718 .id_table = ds1374_id,
721 module_i2c_driver(ds1374_driver);
723 MODULE_AUTHOR("Scott Wood <scottwood@freescale.com>");
724 MODULE_DESCRIPTION("Maxim/Dallas DS1374 RTC Driver");
725 MODULE_LICENSE("GPL");