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.
8 * Copyright (C) 1999 Hewlett-Packard Co.
9 * Copyright (C) 1999 Stephane Eranian <eranian@hpl.hp.com>
15 #include <linux/types.h>
16 #include <linux/interrupt.h>
17 #include <uapi/linux/rtc.h>
19 extern int rtc_month_days(unsigned int month
, unsigned int year
);
20 extern int rtc_year_days(unsigned int day
, unsigned int month
, unsigned int year
);
21 extern int rtc_valid_tm(struct rtc_time
*tm
);
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
);
24 ktime_t
rtc_tm_to_ktime(struct rtc_time tm
);
25 struct rtc_time
rtc_ktime_to_tm(ktime_t kt
);
28 * Deprecated. Use rtc_time64_to_tm().
30 static inline void rtc_time_to_tm(unsigned long time
, struct rtc_time
*tm
)
32 rtc_time64_to_tm(time
, tm
);
36 * Deprecated. Use rtc_tm_to_time64().
38 static inline int rtc_tm_to_time(struct rtc_time
*tm
, unsigned long *time
)
40 *time
= rtc_tm_to_time64(tm
);
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>
50 #include <linux/timerqueue.h>
51 #include <linux/workqueue.h>
53 extern struct class *rtc_class
;
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.
61 * Most of these methods are called with rtc_device.ops_lock held,
62 * through the rtc_*(struct rtc_device *, ...) calls.
64 * The (current) exceptions are mostly filesystem hooks:
65 * - the proc() hook for procfs
66 * - non-ioctl() chardev hooks: open(), release(), read_callback()
68 * REVISIT those periodic irq calls *do* have ops_lock when they're
69 * issued through ioctl() ...
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
*);
80 int (*set_mmss
)(struct device
*, unsigned long secs
);
81 int (*read_callback
)(struct device
*, int data
);
82 int (*alarm_irq_enable
)(struct device
*, unsigned int enabled
);
85 #define RTC_DEVICE_NAME_SIZE 20
86 typedef struct rtc_task
{
87 void (*func
)(void *private_data
);
94 struct timerqueue_node node
;
101 #define RTC_DEV_BUSY 0
106 struct module
*owner
;
109 char name
[RTC_DEVICE_NAME_SIZE
];
111 const struct rtc_class_ops
*ops
;
112 struct mutex ops_lock
;
114 struct cdev char_dev
;
117 unsigned long irq_data
;
119 wait_queue_head_t irq_queue
;
120 struct fasync_struct
*async_queue
;
122 struct rtc_task
*irq_task
;
123 spinlock_t irq_task_lock
;
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 */
132 struct work_struct irqwork
;
133 /* Some hardware can't support UIE mode */
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;
147 #define to_rtc_device(d) container_of(d, struct rtc_device, dev)
149 extern struct rtc_device
*rtc_device_register(const char *name
,
151 const struct rtc_class_ops
*ops
,
152 struct module
*owner
);
153 extern struct rtc_device
*devm_rtc_device_register(struct device
*dev
,
155 const struct rtc_class_ops
*ops
,
156 struct module
*owner
);
157 extern void rtc_device_unregister(struct rtc_device
*rtc
);
158 extern void devm_rtc_device_unregister(struct device
*dev
,
159 struct rtc_device
*rtc
);
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
);
164 extern int rtc_set_ntp_time(struct timespec now
);
165 int __rtc_read_alarm(struct rtc_device
*rtc
, struct rtc_wkalrm
*alarm
);
166 extern int rtc_read_alarm(struct rtc_device
*rtc
,
167 struct rtc_wkalrm
*alrm
);
168 extern int rtc_set_alarm(struct rtc_device
*rtc
,
169 struct rtc_wkalrm
*alrm
);
170 extern int rtc_initialize_alarm(struct rtc_device
*rtc
,
171 struct rtc_wkalrm
*alrm
);
172 extern void rtc_update_irq(struct rtc_device
*rtc
,
173 unsigned long num
, unsigned long events
);
175 extern struct rtc_device
*rtc_class_open(const char *name
);
176 extern void rtc_class_close(struct rtc_device
*rtc
);
178 extern int rtc_irq_register(struct rtc_device
*rtc
,
179 struct rtc_task
*task
);
180 extern void rtc_irq_unregister(struct rtc_device
*rtc
,
181 struct rtc_task
*task
);
182 extern int rtc_irq_set_state(struct rtc_device
*rtc
,
183 struct rtc_task
*task
, int enabled
);
184 extern int rtc_irq_set_freq(struct rtc_device
*rtc
,
185 struct rtc_task
*task
, int freq
);
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
);
188 extern int rtc_dev_update_irq_enable_emul(struct rtc_device
*rtc
,
189 unsigned int enabled
);
191 void rtc_handle_legacy_irq(struct rtc_device
*rtc
, int num
, int mode
);
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
);
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
);
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
);
204 void rtc_timer_do_work(struct work_struct
*work
);
206 static inline bool is_leap_year(unsigned int year
)
208 return (!(year
% 4) && (year
% 100)) || !(year
% 400);
211 #ifdef CONFIG_RTC_HCTOSYS_DEVICE
212 extern int rtc_hctosys_ret
;
214 #define rtc_hctosys_ret -ENODEV
217 #endif /* _LINUX_RTC_H_ */