Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Generic RTC interface. |
| 3 | * This version contains the part of the user interface to the Real Time Clock |
| 4 | * service. It is used with both the legacy mc146818 and also EFI |
| 5 | * Struct rtc_time and first 12 ioctl by Paul Gortmaker, 1996 - separated out |
| 6 | * from <linux/mc146818rtc.h> to this file for 2.4 kernels. |
David Brownell | ab6a2d7 | 2007-05-08 00:33:30 -0700 | [diff] [blame] | 7 | * |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 8 | * Copyright (C) 1999 Hewlett-Packard Co. |
| 9 | * Copyright (C) 1999 Stephane Eranian <eranian@hpl.hp.com> |
| 10 | */ |
| 11 | #ifndef _LINUX_RTC_H_ |
| 12 | #define _LINUX_RTC_H_ |
| 13 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 14 | |
Andrew Morton | 78d89ef | 2009-03-31 15:24:48 -0700 | [diff] [blame] | 15 | #include <linux/types.h> |
Joe Korty | 4024ce5 | 2006-03-22 00:07:43 -0800 | [diff] [blame] | 16 | #include <linux/interrupt.h> |
David Howells | 607ca46 | 2012-10-13 10:46:48 +0100 | [diff] [blame] | 17 | #include <uapi/linux/rtc.h> |
Joe Korty | 4024ce5 | 2006-03-22 00:07:43 -0800 | [diff] [blame] | 18 | |
Alessandro Zummo | c58411e | 2006-03-27 01:16:34 -0800 | [diff] [blame] | 19 | extern int rtc_month_days(unsigned int month, unsigned int year); |
Andrew Victor | 8232212 | 2006-06-25 05:48:25 -0700 | [diff] [blame] | 20 | extern int rtc_year_days(unsigned int day, unsigned int month, unsigned int year); |
Alessandro Zummo | c58411e | 2006-03-27 01:16:34 -0800 | [diff] [blame] | 21 | extern int rtc_valid_tm(struct rtc_time *tm); |
pang.xunlei | c2c11ae | 2014-11-18 19:15:19 +0800 | [diff] [blame] | 22 | extern time64_t rtc_tm_to_time64(struct rtc_time *tm); |
| 23 | extern void rtc_time64_to_tm(time64_t time, struct rtc_time *tm); |
John Stultz | 6610e08 | 2010-09-23 15:07:34 -0700 | [diff] [blame] | 24 | ktime_t rtc_tm_to_ktime(struct rtc_time tm); |
| 25 | struct rtc_time rtc_ktime_to_tm(ktime_t kt); |
| 26 | |
pang.xunlei | c2c11ae | 2014-11-18 19:15:19 +0800 | [diff] [blame] | 27 | /** |
| 28 | * Deprecated. Use rtc_time64_to_tm(). |
| 29 | */ |
| 30 | static inline void rtc_time_to_tm(unsigned long time, struct rtc_time *tm) |
| 31 | { |
| 32 | rtc_time64_to_tm(time, tm); |
| 33 | } |
| 34 | |
| 35 | /** |
| 36 | * Deprecated. Use rtc_tm_to_time64(). |
| 37 | */ |
| 38 | static inline int rtc_tm_to_time(struct rtc_time *tm, unsigned long *time) |
| 39 | { |
| 40 | *time = rtc_tm_to_time64(tm); |
| 41 | |
| 42 | return 0; |
| 43 | } |
Alessandro Zummo | c58411e | 2006-03-27 01:16:34 -0800 | [diff] [blame] | 44 | |
Alessandro Zummo | 0c86edc | 2006-03-27 01:16:37 -0800 | [diff] [blame] | 45 | #include <linux/device.h> |
| 46 | #include <linux/seq_file.h> |
| 47 | #include <linux/cdev.h> |
| 48 | #include <linux/poll.h> |
| 49 | #include <linux/mutex.h> |
John Stultz | 6610e08 | 2010-09-23 15:07:34 -0700 | [diff] [blame] | 50 | #include <linux/timerqueue.h> |
| 51 | #include <linux/workqueue.h> |
Alessandro Zummo | 0c86edc | 2006-03-27 01:16:37 -0800 | [diff] [blame] | 52 | |
| 53 | extern struct class *rtc_class; |
| 54 | |
David Brownell | 5ad31a57 | 2008-07-23 21:30:33 -0700 | [diff] [blame] | 55 | /* |
| 56 | * For these RTC methods the device parameter is the physical device |
| 57 | * on whatever bus holds the hardware (I2C, Platform, SPI, etc), which |
| 58 | * was passed to rtc_device_register(). Its driver_data normally holds |
| 59 | * device state, including the rtc_device pointer for the RTC. |
| 60 | * |
| 61 | * Most of these methods are called with rtc_device.ops_lock held, |
| 62 | * through the rtc_*(struct rtc_device *, ...) calls. |
| 63 | * |
| 64 | * The (current) exceptions are mostly filesystem hooks: |
| 65 | * - the proc() hook for procfs |
| 66 | * - non-ioctl() chardev hooks: open(), release(), read_callback() |
David Brownell | 5ad31a57 | 2008-07-23 21:30:33 -0700 | [diff] [blame] | 67 | * |
| 68 | * REVISIT those periodic irq calls *do* have ops_lock when they're |
| 69 | * issued through ioctl() ... |
| 70 | */ |
Alessandro Zummo | 0c86edc | 2006-03-27 01:16:37 -0800 | [diff] [blame] | 71 | struct rtc_class_ops { |
| 72 | int (*open)(struct device *); |
| 73 | void (*release)(struct device *); |
| 74 | int (*ioctl)(struct device *, unsigned int, unsigned long); |
| 75 | int (*read_time)(struct device *, struct rtc_time *); |
| 76 | int (*set_time)(struct device *, struct rtc_time *); |
| 77 | int (*read_alarm)(struct device *, struct rtc_wkalrm *); |
| 78 | int (*set_alarm)(struct device *, struct rtc_wkalrm *); |
| 79 | int (*proc)(struct device *, struct seq_file *); |
Xunlei Pang | 8e4ff1a | 2015-04-01 20:34:27 -0700 | [diff] [blame] | 80 | int (*set_mmss64)(struct device *, time64_t secs); |
Alessandro Zummo | 0c86edc | 2006-03-27 01:16:37 -0800 | [diff] [blame] | 81 | int (*set_mmss)(struct device *, unsigned long secs); |
Alessandro Zummo | 0c86edc | 2006-03-27 01:16:37 -0800 | [diff] [blame] | 82 | int (*read_callback)(struct device *, int data); |
Alessandro Zummo | 099e657 | 2009-01-04 12:00:54 -0800 | [diff] [blame] | 83 | int (*alarm_irq_enable)(struct device *, unsigned int enabled); |
Alessandro Zummo | 0c86edc | 2006-03-27 01:16:37 -0800 | [diff] [blame] | 84 | }; |
| 85 | |
| 86 | #define RTC_DEVICE_NAME_SIZE 20 |
John Stultz | 6610e08 | 2010-09-23 15:07:34 -0700 | [diff] [blame] | 87 | typedef struct rtc_task { |
| 88 | void (*func)(void *private_data); |
| 89 | void *private_data; |
| 90 | } rtc_task_t; |
| 91 | |
| 92 | |
| 93 | struct rtc_timer { |
| 94 | struct rtc_task task; |
| 95 | struct timerqueue_node node; |
| 96 | ktime_t period; |
| 97 | int enabled; |
| 98 | }; |
| 99 | |
Alessandro Zummo | 0c86edc | 2006-03-27 01:16:37 -0800 | [diff] [blame] | 100 | |
Jiri Kosina | 8853c20 | 2007-11-28 16:22:03 -0800 | [diff] [blame] | 101 | /* flags */ |
| 102 | #define RTC_DEV_BUSY 0 |
| 103 | |
Krzysztof Kozlowski | 1796dcc | 2015-05-03 18:57:10 +0900 | [diff] [blame^] | 104 | struct rtc_device { |
David Brownell | cd96620 | 2007-05-08 00:33:40 -0700 | [diff] [blame] | 105 | struct device dev; |
Alessandro Zummo | 0c86edc | 2006-03-27 01:16:37 -0800 | [diff] [blame] | 106 | struct module *owner; |
| 107 | |
| 108 | int id; |
| 109 | char name[RTC_DEVICE_NAME_SIZE]; |
| 110 | |
David Brownell | ff8371a | 2006-09-30 23:28:17 -0700 | [diff] [blame] | 111 | const struct rtc_class_ops *ops; |
Alessandro Zummo | 0c86edc | 2006-03-27 01:16:37 -0800 | [diff] [blame] | 112 | struct mutex ops_lock; |
| 113 | |
Alessandro Zummo | 0c86edc | 2006-03-27 01:16:37 -0800 | [diff] [blame] | 114 | struct cdev char_dev; |
Jiri Kosina | 8853c20 | 2007-11-28 16:22:03 -0800 | [diff] [blame] | 115 | unsigned long flags; |
Alessandro Zummo | 0c86edc | 2006-03-27 01:16:37 -0800 | [diff] [blame] | 116 | |
| 117 | unsigned long irq_data; |
| 118 | spinlock_t irq_lock; |
| 119 | wait_queue_head_t irq_queue; |
| 120 | struct fasync_struct *async_queue; |
| 121 | |
| 122 | struct rtc_task *irq_task; |
| 123 | spinlock_t irq_task_lock; |
| 124 | int irq_freq; |
Alessandro Zummo | 110d693 | 2006-06-25 05:48:20 -0700 | [diff] [blame] | 125 | int max_user_freq; |
John Stultz | 6610e08 | 2010-09-23 15:07:34 -0700 | [diff] [blame] | 126 | |
| 127 | struct timerqueue_head timerqueue; |
| 128 | struct rtc_timer aie_timer; |
| 129 | struct rtc_timer uie_rtctimer; |
| 130 | struct hrtimer pie_timer; /* sub second exp, so needs hrtimer */ |
| 131 | int pie_enabled; |
| 132 | struct work_struct irqwork; |
John Stultz | 4a64990 | 2012-03-06 17:16:09 -0800 | [diff] [blame] | 133 | /* Some hardware can't support UIE mode */ |
| 134 | int uie_unsupported; |
John Stultz | 6e57b1d | 2011-02-11 17:45:40 -0800 | [diff] [blame] | 135 | |
| 136 | #ifdef CONFIG_RTC_INTF_DEV_UIE_EMUL |
| 137 | struct work_struct uie_task; |
| 138 | struct timer_list uie_timer; |
| 139 | /* Those fields are protected by rtc->irq_lock */ |
| 140 | unsigned int oldsecs; |
| 141 | unsigned int uie_irq_active:1; |
| 142 | unsigned int stop_uie_polling:1; |
| 143 | unsigned int uie_task_active:1; |
| 144 | unsigned int uie_timer_active:1; |
| 145 | #endif |
Alessandro Zummo | 0c86edc | 2006-03-27 01:16:37 -0800 | [diff] [blame] | 146 | }; |
David Brownell | cd96620 | 2007-05-08 00:33:40 -0700 | [diff] [blame] | 147 | #define to_rtc_device(d) container_of(d, struct rtc_device, dev) |
Alessandro Zummo | 0c86edc | 2006-03-27 01:16:37 -0800 | [diff] [blame] | 148 | |
| 149 | extern struct rtc_device *rtc_device_register(const char *name, |
| 150 | struct device *dev, |
David Brownell | ff8371a | 2006-09-30 23:28:17 -0700 | [diff] [blame] | 151 | const struct rtc_class_ops *ops, |
Alessandro Zummo | 0c86edc | 2006-03-27 01:16:37 -0800 | [diff] [blame] | 152 | struct module *owner); |
Jingoo Han | 6636a99 | 2013-04-29 16:18:33 -0700 | [diff] [blame] | 153 | extern struct rtc_device *devm_rtc_device_register(struct device *dev, |
| 154 | const char *name, |
Jingoo Han | 3e217b6 | 2013-04-29 16:18:27 -0700 | [diff] [blame] | 155 | const struct rtc_class_ops *ops, |
| 156 | struct module *owner); |
David Brownell | ab6a2d7 | 2007-05-08 00:33:30 -0700 | [diff] [blame] | 157 | extern void rtc_device_unregister(struct rtc_device *rtc); |
Jingoo Han | 3e217b6 | 2013-04-29 16:18:27 -0700 | [diff] [blame] | 158 | extern void devm_rtc_device_unregister(struct device *dev, |
| 159 | struct rtc_device *rtc); |
Alessandro Zummo | 0c86edc | 2006-03-27 01:16:37 -0800 | [diff] [blame] | 160 | |
David Brownell | ab6a2d7 | 2007-05-08 00:33:30 -0700 | [diff] [blame] | 161 | extern int rtc_read_time(struct rtc_device *rtc, struct rtc_time *tm); |
| 162 | extern int rtc_set_time(struct rtc_device *rtc, struct rtc_time *tm); |
| 163 | extern int rtc_set_mmss(struct rtc_device *rtc, unsigned long secs); |
Xunlei Pang | 9a4a445 | 2015-01-22 02:31:55 +0000 | [diff] [blame] | 164 | extern int rtc_set_ntp_time(struct timespec64 now); |
John Stultz | f44f7f9 | 2011-02-21 22:58:51 -0800 | [diff] [blame] | 165 | int __rtc_read_alarm(struct rtc_device *rtc, struct rtc_wkalrm *alarm); |
David Brownell | ab6a2d7 | 2007-05-08 00:33:30 -0700 | [diff] [blame] | 166 | extern int rtc_read_alarm(struct rtc_device *rtc, |
Alessandro Zummo | 0c86edc | 2006-03-27 01:16:37 -0800 | [diff] [blame] | 167 | struct rtc_wkalrm *alrm); |
David Brownell | ab6a2d7 | 2007-05-08 00:33:30 -0700 | [diff] [blame] | 168 | extern int rtc_set_alarm(struct rtc_device *rtc, |
Alessandro Zummo | 0c86edc | 2006-03-27 01:16:37 -0800 | [diff] [blame] | 169 | struct rtc_wkalrm *alrm); |
John Stultz | f6d5b33 | 2011-03-29 18:00:27 -0700 | [diff] [blame] | 170 | extern int rtc_initialize_alarm(struct rtc_device *rtc, |
| 171 | struct rtc_wkalrm *alrm); |
David Brownell | ab6a2d7 | 2007-05-08 00:33:30 -0700 | [diff] [blame] | 172 | extern void rtc_update_irq(struct rtc_device *rtc, |
Alessandro Zummo | 0c86edc | 2006-03-27 01:16:37 -0800 | [diff] [blame] | 173 | unsigned long num, unsigned long events); |
| 174 | |
Michał Mirosław | 9f3b795 | 2013-02-01 20:40:17 +0100 | [diff] [blame] | 175 | extern struct rtc_device *rtc_class_open(const char *name); |
David Brownell | ab6a2d7 | 2007-05-08 00:33:30 -0700 | [diff] [blame] | 176 | extern void rtc_class_close(struct rtc_device *rtc); |
Alessandro Zummo | 0c86edc | 2006-03-27 01:16:37 -0800 | [diff] [blame] | 177 | |
David Brownell | ab6a2d7 | 2007-05-08 00:33:30 -0700 | [diff] [blame] | 178 | extern int rtc_irq_register(struct rtc_device *rtc, |
Alessandro Zummo | 0c86edc | 2006-03-27 01:16:37 -0800 | [diff] [blame] | 179 | struct rtc_task *task); |
David Brownell | ab6a2d7 | 2007-05-08 00:33:30 -0700 | [diff] [blame] | 180 | extern void rtc_irq_unregister(struct rtc_device *rtc, |
Alessandro Zummo | 0c86edc | 2006-03-27 01:16:37 -0800 | [diff] [blame] | 181 | struct rtc_task *task); |
David Brownell | ab6a2d7 | 2007-05-08 00:33:30 -0700 | [diff] [blame] | 182 | extern int rtc_irq_set_state(struct rtc_device *rtc, |
Alessandro Zummo | 0c86edc | 2006-03-27 01:16:37 -0800 | [diff] [blame] | 183 | struct rtc_task *task, int enabled); |
David Brownell | ab6a2d7 | 2007-05-08 00:33:30 -0700 | [diff] [blame] | 184 | extern int rtc_irq_set_freq(struct rtc_device *rtc, |
Alessandro Zummo | 0c86edc | 2006-03-27 01:16:37 -0800 | [diff] [blame] | 185 | struct rtc_task *task, int freq); |
Alessandro Zummo | 099e657 | 2009-01-04 12:00:54 -0800 | [diff] [blame] | 186 | extern int rtc_update_irq_enable(struct rtc_device *rtc, unsigned int enabled); |
| 187 | extern int rtc_alarm_irq_enable(struct rtc_device *rtc, unsigned int enabled); |
John Stultz | 6e57b1d | 2011-02-11 17:45:40 -0800 | [diff] [blame] | 188 | extern int rtc_dev_update_irq_enable_emul(struct rtc_device *rtc, |
| 189 | unsigned int enabled); |
Alessandro Zummo | 0c86edc | 2006-03-27 01:16:37 -0800 | [diff] [blame] | 190 | |
John Stultz | 456d66e | 2011-02-11 18:15:23 -0800 | [diff] [blame] | 191 | void rtc_handle_legacy_irq(struct rtc_device *rtc, int num, int mode); |
John Stultz | 6610e08 | 2010-09-23 15:07:34 -0700 | [diff] [blame] | 192 | void rtc_aie_update_irq(void *private); |
| 193 | void rtc_uie_update_irq(void *private); |
| 194 | enum hrtimer_restart rtc_pie_update_irq(struct hrtimer *timer); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 195 | |
| 196 | int rtc_register(rtc_task_t *task); |
| 197 | int rtc_unregister(rtc_task_t *task); |
| 198 | int rtc_control(rtc_task_t *t, unsigned int cmd, unsigned long arg); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 199 | |
Krzysztof Kozlowski | 1796dcc | 2015-05-03 18:57:10 +0900 | [diff] [blame^] | 200 | void rtc_timer_init(struct rtc_timer *timer, void (*f)(void *p), void *data); |
| 201 | int rtc_timer_start(struct rtc_device *rtc, struct rtc_timer *timer, |
| 202 | ktime_t expires, ktime_t period); |
| 203 | int rtc_timer_cancel(struct rtc_device *rtc, struct rtc_timer *timer); |
Thomas Gleixner | 96c8f06 | 2010-12-13 22:45:48 +0100 | [diff] [blame] | 204 | void rtc_timer_do_work(struct work_struct *work); |
John Stultz | 6610e08 | 2010-09-23 15:07:34 -0700 | [diff] [blame] | 205 | |
Andrew Morton | 78d89ef | 2009-03-31 15:24:48 -0700 | [diff] [blame] | 206 | static inline bool is_leap_year(unsigned int year) |
| 207 | { |
| 208 | return (!(year % 4) && (year % 100)) || !(year % 400); |
| 209 | } |
| 210 | |
David Fries | 4c24e29 | 2012-10-04 17:14:12 -0700 | [diff] [blame] | 211 | #ifdef CONFIG_RTC_HCTOSYS_DEVICE |
Uwe Kleine-König | d0ab4a4 | 2010-03-10 15:20:35 -0800 | [diff] [blame] | 212 | extern int rtc_hctosys_ret; |
| 213 | #else |
| 214 | #define rtc_hctosys_ret -ENODEV |
| 215 | #endif |
| 216 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 217 | #endif /* _LINUX_RTC_H_ */ |