blob: 3359f0422c6b5bcf7c9385ecff8a90ce28dc1eae [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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 Brownellab6a2d72007-05-08 00:33:30 -07007 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07008 * 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 Torvalds1da177e2005-04-16 15:20:36 -070014
Andrew Morton78d89ef2009-03-31 15:24:48 -070015#include <linux/types.h>
Joe Korty4024ce52006-03-22 00:07:43 -080016#include <linux/interrupt.h>
David Howells607ca462012-10-13 10:46:48 +010017#include <uapi/linux/rtc.h>
Joe Korty4024ce52006-03-22 00:07:43 -080018
Alessandro Zummoc58411e2006-03-27 01:16:34 -080019extern int rtc_month_days(unsigned int month, unsigned int year);
Andrew Victor82322122006-06-25 05:48:25 -070020extern int rtc_year_days(unsigned int day, unsigned int month, unsigned int year);
Alessandro Zummoc58411e2006-03-27 01:16:34 -080021extern int rtc_valid_tm(struct rtc_time *tm);
pang.xunleic2c11ae2014-11-18 19:15:19 +080022extern time64_t rtc_tm_to_time64(struct rtc_time *tm);
23extern void rtc_time64_to_tm(time64_t time, struct rtc_time *tm);
John Stultz6610e082010-09-23 15:07:34 -070024ktime_t rtc_tm_to_ktime(struct rtc_time tm);
25struct rtc_time rtc_ktime_to_tm(ktime_t kt);
26
Xunlei Pang92000252015-06-12 10:04:10 +080027/*
28 * rtc_tm_sub - Return the difference in seconds.
29 */
30static inline time64_t rtc_tm_sub(struct rtc_time *lhs, struct rtc_time *rhs)
31{
32 return rtc_tm_to_time64(lhs) - rtc_tm_to_time64(rhs);
33}
34
pang.xunleic2c11ae2014-11-18 19:15:19 +080035/**
36 * Deprecated. Use rtc_time64_to_tm().
37 */
38static inline void rtc_time_to_tm(unsigned long time, struct rtc_time *tm)
39{
40 rtc_time64_to_tm(time, tm);
41}
42
43/**
44 * Deprecated. Use rtc_tm_to_time64().
45 */
46static inline int rtc_tm_to_time(struct rtc_time *tm, unsigned long *time)
47{
48 *time = rtc_tm_to_time64(tm);
49
50 return 0;
51}
Alessandro Zummoc58411e2006-03-27 01:16:34 -080052
Alessandro Zummo0c86edc2006-03-27 01:16:37 -080053#include <linux/device.h>
54#include <linux/seq_file.h>
55#include <linux/cdev.h>
56#include <linux/poll.h>
57#include <linux/mutex.h>
John Stultz6610e082010-09-23 15:07:34 -070058#include <linux/timerqueue.h>
59#include <linux/workqueue.h>
Alessandro Zummo0c86edc2006-03-27 01:16:37 -080060
61extern struct class *rtc_class;
62
David Brownell5ad31a572008-07-23 21:30:33 -070063/*
64 * For these RTC methods the device parameter is the physical device
65 * on whatever bus holds the hardware (I2C, Platform, SPI, etc), which
66 * was passed to rtc_device_register(). Its driver_data normally holds
67 * device state, including the rtc_device pointer for the RTC.
68 *
69 * Most of these methods are called with rtc_device.ops_lock held,
70 * through the rtc_*(struct rtc_device *, ...) calls.
71 *
72 * The (current) exceptions are mostly filesystem hooks:
73 * - the proc() hook for procfs
74 * - non-ioctl() chardev hooks: open(), release(), read_callback()
David Brownell5ad31a572008-07-23 21:30:33 -070075 *
76 * REVISIT those periodic irq calls *do* have ops_lock when they're
77 * issued through ioctl() ...
78 */
Alessandro Zummo0c86edc2006-03-27 01:16:37 -080079struct rtc_class_ops {
80 int (*open)(struct device *);
81 void (*release)(struct device *);
82 int (*ioctl)(struct device *, unsigned int, unsigned long);
83 int (*read_time)(struct device *, struct rtc_time *);
84 int (*set_time)(struct device *, struct rtc_time *);
85 int (*read_alarm)(struct device *, struct rtc_wkalrm *);
86 int (*set_alarm)(struct device *, struct rtc_wkalrm *);
87 int (*proc)(struct device *, struct seq_file *);
Xunlei Pang8e4ff1a2015-04-01 20:34:27 -070088 int (*set_mmss64)(struct device *, time64_t secs);
Alessandro Zummo0c86edc2006-03-27 01:16:37 -080089 int (*set_mmss)(struct device *, unsigned long secs);
Alessandro Zummo0c86edc2006-03-27 01:16:37 -080090 int (*read_callback)(struct device *, int data);
Alessandro Zummo099e6572009-01-04 12:00:54 -080091 int (*alarm_irq_enable)(struct device *, unsigned int enabled);
Alessandro Zummo0c86edc2006-03-27 01:16:37 -080092};
93
94#define RTC_DEVICE_NAME_SIZE 20
John Stultz6610e082010-09-23 15:07:34 -070095typedef struct rtc_task {
96 void (*func)(void *private_data);
97 void *private_data;
98} rtc_task_t;
99
100
101struct rtc_timer {
102 struct rtc_task task;
103 struct timerqueue_node node;
104 ktime_t period;
105 int enabled;
106};
107
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800108
Jiri Kosina8853c202007-11-28 16:22:03 -0800109/* flags */
110#define RTC_DEV_BUSY 0
111
Krzysztof Kozlowski1796dcc2015-05-03 18:57:10 +0900112struct rtc_device {
David Brownellcd966202007-05-08 00:33:40 -0700113 struct device dev;
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800114 struct module *owner;
115
116 int id;
117 char name[RTC_DEVICE_NAME_SIZE];
118
David Brownellff8371a2006-09-30 23:28:17 -0700119 const struct rtc_class_ops *ops;
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800120 struct mutex ops_lock;
121
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800122 struct cdev char_dev;
Jiri Kosina8853c202007-11-28 16:22:03 -0800123 unsigned long flags;
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800124
125 unsigned long irq_data;
126 spinlock_t irq_lock;
127 wait_queue_head_t irq_queue;
128 struct fasync_struct *async_queue;
129
130 struct rtc_task *irq_task;
131 spinlock_t irq_task_lock;
132 int irq_freq;
Alessandro Zummo110d6932006-06-25 05:48:20 -0700133 int max_user_freq;
John Stultz6610e082010-09-23 15:07:34 -0700134
135 struct timerqueue_head timerqueue;
136 struct rtc_timer aie_timer;
137 struct rtc_timer uie_rtctimer;
138 struct hrtimer pie_timer; /* sub second exp, so needs hrtimer */
139 int pie_enabled;
140 struct work_struct irqwork;
John Stultz4a649902012-03-06 17:16:09 -0800141 /* Some hardware can't support UIE mode */
142 int uie_unsupported;
John Stultz6e57b1d2011-02-11 17:45:40 -0800143
144#ifdef CONFIG_RTC_INTF_DEV_UIE_EMUL
145 struct work_struct uie_task;
146 struct timer_list uie_timer;
147 /* Those fields are protected by rtc->irq_lock */
148 unsigned int oldsecs;
149 unsigned int uie_irq_active:1;
150 unsigned int stop_uie_polling:1;
151 unsigned int uie_task_active:1;
152 unsigned int uie_timer_active:1;
153#endif
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800154};
David Brownellcd966202007-05-08 00:33:40 -0700155#define to_rtc_device(d) container_of(d, struct rtc_device, dev)
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800156
157extern struct rtc_device *rtc_device_register(const char *name,
158 struct device *dev,
David Brownellff8371a2006-09-30 23:28:17 -0700159 const struct rtc_class_ops *ops,
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800160 struct module *owner);
Jingoo Han6636a992013-04-29 16:18:33 -0700161extern struct rtc_device *devm_rtc_device_register(struct device *dev,
162 const char *name,
Jingoo Han3e217b62013-04-29 16:18:27 -0700163 const struct rtc_class_ops *ops,
164 struct module *owner);
David Brownellab6a2d72007-05-08 00:33:30 -0700165extern void rtc_device_unregister(struct rtc_device *rtc);
Jingoo Han3e217b62013-04-29 16:18:27 -0700166extern void devm_rtc_device_unregister(struct device *dev,
167 struct rtc_device *rtc);
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800168
David Brownellab6a2d72007-05-08 00:33:30 -0700169extern int rtc_read_time(struct rtc_device *rtc, struct rtc_time *tm);
170extern int rtc_set_time(struct rtc_device *rtc, struct rtc_time *tm);
Xunlei Pang9a4a4452015-01-22 02:31:55 +0000171extern int rtc_set_ntp_time(struct timespec64 now);
John Stultzf44f7f92011-02-21 22:58:51 -0800172int __rtc_read_alarm(struct rtc_device *rtc, struct rtc_wkalrm *alarm);
David Brownellab6a2d72007-05-08 00:33:30 -0700173extern int rtc_read_alarm(struct rtc_device *rtc,
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800174 struct rtc_wkalrm *alrm);
David Brownellab6a2d72007-05-08 00:33:30 -0700175extern int rtc_set_alarm(struct rtc_device *rtc,
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800176 struct rtc_wkalrm *alrm);
John Stultzf6d5b332011-03-29 18:00:27 -0700177extern int rtc_initialize_alarm(struct rtc_device *rtc,
178 struct rtc_wkalrm *alrm);
David Brownellab6a2d72007-05-08 00:33:30 -0700179extern void rtc_update_irq(struct rtc_device *rtc,
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800180 unsigned long num, unsigned long events);
181
Michał Mirosław9f3b7952013-02-01 20:40:17 +0100182extern struct rtc_device *rtc_class_open(const char *name);
David Brownellab6a2d72007-05-08 00:33:30 -0700183extern void rtc_class_close(struct rtc_device *rtc);
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800184
David Brownellab6a2d72007-05-08 00:33:30 -0700185extern int rtc_irq_register(struct rtc_device *rtc,
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800186 struct rtc_task *task);
David Brownellab6a2d72007-05-08 00:33:30 -0700187extern void rtc_irq_unregister(struct rtc_device *rtc,
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800188 struct rtc_task *task);
David Brownellab6a2d72007-05-08 00:33:30 -0700189extern int rtc_irq_set_state(struct rtc_device *rtc,
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800190 struct rtc_task *task, int enabled);
David Brownellab6a2d72007-05-08 00:33:30 -0700191extern int rtc_irq_set_freq(struct rtc_device *rtc,
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800192 struct rtc_task *task, int freq);
Alessandro Zummo099e6572009-01-04 12:00:54 -0800193extern int rtc_update_irq_enable(struct rtc_device *rtc, unsigned int enabled);
194extern int rtc_alarm_irq_enable(struct rtc_device *rtc, unsigned int enabled);
John Stultz6e57b1d2011-02-11 17:45:40 -0800195extern int rtc_dev_update_irq_enable_emul(struct rtc_device *rtc,
196 unsigned int enabled);
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800197
John Stultz456d66e2011-02-11 18:15:23 -0800198void rtc_handle_legacy_irq(struct rtc_device *rtc, int num, int mode);
John Stultz6610e082010-09-23 15:07:34 -0700199void rtc_aie_update_irq(void *private);
200void rtc_uie_update_irq(void *private);
201enum hrtimer_restart rtc_pie_update_irq(struct hrtimer *timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202
203int rtc_register(rtc_task_t *task);
204int rtc_unregister(rtc_task_t *task);
205int rtc_control(rtc_task_t *t, unsigned int cmd, unsigned long arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206
Krzysztof Kozlowski1796dcc2015-05-03 18:57:10 +0900207void rtc_timer_init(struct rtc_timer *timer, void (*f)(void *p), void *data);
208int rtc_timer_start(struct rtc_device *rtc, struct rtc_timer *timer,
209 ktime_t expires, ktime_t period);
Krzysztof Kozlowski73744a62015-05-03 18:57:11 +0900210void rtc_timer_cancel(struct rtc_device *rtc, struct rtc_timer *timer);
Thomas Gleixner96c8f062010-12-13 22:45:48 +0100211void rtc_timer_do_work(struct work_struct *work);
John Stultz6610e082010-09-23 15:07:34 -0700212
Andrew Morton78d89ef2009-03-31 15:24:48 -0700213static inline bool is_leap_year(unsigned int year)
214{
215 return (!(year % 4) && (year % 100)) || !(year % 400);
216}
217
David Fries4c24e292012-10-04 17:14:12 -0700218#ifdef CONFIG_RTC_HCTOSYS_DEVICE
Uwe Kleine-Königd0ab4a42010-03-10 15:20:35 -0800219extern int rtc_hctosys_ret;
220#else
221#define rtc_hctosys_ret -ENODEV
222#endif
223
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224#endif /* _LINUX_RTC_H_ */