1
2
3
4
5
6
7
8
9
10
11
12#ifndef _LINUX_RTC_H_
13#define _LINUX_RTC_H_
14
15
16#include <linux/types.h>
17#include <linux/interrupt.h>
18#include <linux/nvmem-provider.h>
19#include <uapi/linux/rtc.h>
20
21extern int rtc_month_days(unsigned int month, unsigned int year);
22extern int rtc_year_days(unsigned int day, unsigned int month, unsigned int year);
23extern int rtc_valid_tm(struct rtc_time *tm);
24extern time64_t rtc_tm_to_time64(struct rtc_time *tm);
25extern void rtc_time64_to_tm(time64_t time, struct rtc_time *tm);
26ktime_t rtc_tm_to_ktime(struct rtc_time tm);
27struct rtc_time rtc_ktime_to_tm(ktime_t kt);
28
29
30
31
32static inline time64_t rtc_tm_sub(struct rtc_time *lhs, struct rtc_time *rhs)
33{
34 return rtc_tm_to_time64(lhs) - rtc_tm_to_time64(rhs);
35}
36
37static inline void rtc_time_to_tm(unsigned long time, struct rtc_time *tm)
38{
39 rtc_time64_to_tm(time, tm);
40}
41
42static inline int rtc_tm_to_time(struct rtc_time *tm, unsigned long *time)
43{
44 *time = rtc_tm_to_time64(tm);
45
46 return 0;
47}
48
49#include <linux/device.h>
50#include <linux/seq_file.h>
51#include <linux/cdev.h>
52#include <linux/poll.h>
53#include <linux/mutex.h>
54#include <linux/timerqueue.h>
55#include <linux/workqueue.h>
56
57extern struct class *rtc_class;
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75struct rtc_class_ops {
76 int (*ioctl)(struct device *, unsigned int, unsigned long);
77 int (*read_time)(struct device *, struct rtc_time *);
78 int (*set_time)(struct device *, struct rtc_time *);
79 int (*read_alarm)(struct device *, struct rtc_wkalrm *);
80 int (*set_alarm)(struct device *, struct rtc_wkalrm *);
81 int (*proc)(struct device *, struct seq_file *);
82 int (*alarm_irq_enable)(struct device *, unsigned int enabled);
83 int (*read_offset)(struct device *, long *offset);
84 int (*set_offset)(struct device *, long offset);
85};
86
87struct rtc_device;
88
89struct rtc_timer {
90 struct timerqueue_node node;
91 ktime_t period;
92 void (*func)(struct rtc_device *rtc);
93 struct rtc_device *rtc;
94 int enabled;
95};
96
97
98#define RTC_DEV_BUSY 0
99
100struct rtc_device {
101 struct device dev;
102 struct module *owner;
103
104 int id;
105
106 const struct rtc_class_ops *ops;
107 struct mutex ops_lock;
108
109 struct cdev char_dev;
110 unsigned long flags;
111
112 unsigned long irq_data;
113 spinlock_t irq_lock;
114 wait_queue_head_t irq_queue;
115 struct fasync_struct *async_queue;
116
117 int irq_freq;
118 int max_user_freq;
119
120 struct timerqueue_head timerqueue;
121 struct rtc_timer aie_timer;
122 struct rtc_timer uie_rtctimer;
123 struct hrtimer pie_timer;
124 int pie_enabled;
125 struct work_struct irqwork;
126
127 int uie_unsupported;
128
129
130
131
132
133
134
135 long set_offset_nsec;
136
137 bool registered;
138
139
140 bool nvram_old_abi;
141 struct bin_attribute *nvram;
142
143 time64_t range_min;
144 timeu64_t range_max;
145 time64_t start_secs;
146 time64_t offset_secs;
147 bool set_start_time;
148
149#ifdef CONFIG_RTC_INTF_DEV_UIE_EMUL
150 struct work_struct uie_task;
151 struct timer_list uie_timer;
152
153 unsigned int oldsecs;
154 unsigned int uie_irq_active:1;
155 unsigned int stop_uie_polling:1;
156 unsigned int uie_task_active:1;
157 unsigned int uie_timer_active:1;
158#endif
159};
160#define to_rtc_device(d) container_of(d, struct rtc_device, dev)
161
162#define rtc_lock(d) mutex_lock(&d->ops_lock)
163#define rtc_unlock(d) mutex_unlock(&d->ops_lock)
164
165
166#define RTC_TIMESTAMP_BEGIN_0000 -62167219200ULL
167#define RTC_TIMESTAMP_BEGIN_1900 -2208988800LL
168#define RTC_TIMESTAMP_BEGIN_2000 946684800LL
169#define RTC_TIMESTAMP_END_2063 2966371199LL
170#define RTC_TIMESTAMP_END_2099 4102444799LL
171#define RTC_TIMESTAMP_END_2199 7258118399LL
172#define RTC_TIMESTAMP_END_9999 253402300799LL
173
174extern struct rtc_device *devm_rtc_device_register(struct device *dev,
175 const char *name,
176 const struct rtc_class_ops *ops,
177 struct module *owner);
178struct rtc_device *devm_rtc_allocate_device(struct device *dev);
179int __rtc_register_device(struct module *owner, struct rtc_device *rtc);
180
181extern int rtc_read_time(struct rtc_device *rtc, struct rtc_time *tm);
182extern int rtc_set_time(struct rtc_device *rtc, struct rtc_time *tm);
183extern int rtc_set_ntp_time(struct timespec64 now, unsigned long *target_nsec);
184int __rtc_read_alarm(struct rtc_device *rtc, struct rtc_wkalrm *alarm);
185extern int rtc_read_alarm(struct rtc_device *rtc,
186 struct rtc_wkalrm *alrm);
187extern int rtc_set_alarm(struct rtc_device *rtc,
188 struct rtc_wkalrm *alrm);
189extern int rtc_initialize_alarm(struct rtc_device *rtc,
190 struct rtc_wkalrm *alrm);
191extern void rtc_update_irq(struct rtc_device *rtc,
192 unsigned long num, unsigned long events);
193
194extern struct rtc_device *rtc_class_open(const char *name);
195extern void rtc_class_close(struct rtc_device *rtc);
196
197extern int rtc_irq_set_state(struct rtc_device *rtc, int enabled);
198extern int rtc_irq_set_freq(struct rtc_device *rtc, int freq);
199extern int rtc_update_irq_enable(struct rtc_device *rtc, unsigned int enabled);
200extern int rtc_alarm_irq_enable(struct rtc_device *rtc, unsigned int enabled);
201extern int rtc_dev_update_irq_enable_emul(struct rtc_device *rtc,
202 unsigned int enabled);
203
204void rtc_handle_legacy_irq(struct rtc_device *rtc, int num, int mode);
205void rtc_aie_update_irq(struct rtc_device *rtc);
206void rtc_uie_update_irq(struct rtc_device *rtc);
207enum hrtimer_restart rtc_pie_update_irq(struct hrtimer *timer);
208
209void rtc_timer_init(struct rtc_timer *timer, void (*f)(struct rtc_device *r),
210 struct rtc_device *rtc);
211int rtc_timer_start(struct rtc_device *rtc, struct rtc_timer *timer,
212 ktime_t expires, ktime_t period);
213void rtc_timer_cancel(struct rtc_device *rtc, struct rtc_timer *timer);
214int rtc_read_offset(struct rtc_device *rtc, long *offset);
215int rtc_set_offset(struct rtc_device *rtc, long offset);
216void rtc_timer_do_work(struct work_struct *work);
217
218static inline bool is_leap_year(unsigned int year)
219{
220 return (!(year % 4) && (year % 100)) || !(year % 400);
221}
222
223
224
225
226
227
228
229
230
231
232static inline bool rtc_tv_nsec_ok(s64 set_offset_nsec,
233 struct timespec64 *to_set,
234 const struct timespec64 *now)
235{
236
237 const unsigned long TIME_SET_NSEC_FUZZ = TICK_NSEC * 5;
238 struct timespec64 delay = {.tv_sec = 0,
239 .tv_nsec = set_offset_nsec};
240
241 *to_set = timespec64_add(*now, delay);
242
243 if (to_set->tv_nsec < TIME_SET_NSEC_FUZZ) {
244 to_set->tv_nsec = 0;
245 return true;
246 }
247
248 if (to_set->tv_nsec > NSEC_PER_SEC - TIME_SET_NSEC_FUZZ) {
249 to_set->tv_sec++;
250 to_set->tv_nsec = 0;
251 return true;
252 }
253 return false;
254}
255
256#define rtc_register_device(device) \
257 __rtc_register_device(THIS_MODULE, device)
258
259#ifdef CONFIG_RTC_HCTOSYS_DEVICE
260extern int rtc_hctosys_ret;
261#else
262#define rtc_hctosys_ret -ENODEV
263#endif
264
265#ifdef CONFIG_RTC_NVMEM
266int rtc_nvmem_register(struct rtc_device *rtc,
267 struct nvmem_config *nvmem_config);
268void rtc_nvmem_unregister(struct rtc_device *rtc);
269#else
270static inline int rtc_nvmem_register(struct rtc_device *rtc,
271 struct nvmem_config *nvmem_config)
272{
273 return 0;
274}
275static inline void rtc_nvmem_unregister(struct rtc_device *rtc) {}
276#endif
277
278#ifdef CONFIG_RTC_INTF_SYSFS
279int rtc_add_group(struct rtc_device *rtc, const struct attribute_group *grp);
280int rtc_add_groups(struct rtc_device *rtc, const struct attribute_group **grps);
281#else
282static inline
283int rtc_add_group(struct rtc_device *rtc, const struct attribute_group *grp)
284{
285 return 0;
286}
287
288static inline
289int rtc_add_groups(struct rtc_device *rtc, const struct attribute_group **grps)
290{
291 return 0;
292}
293#endif
294#endif
295