blob: fcabfb4873c8dd6e8466233de9d557be4bf2101e [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
14/*
15 * The struct used to pass data via the following ioctl. Similar to the
David Brownellab6a2d72007-05-08 00:33:30 -070016 * struct tm in <time.h>, but it needs to be here so that the kernel
Linus Torvalds1da177e2005-04-16 15:20:36 -070017 * source is self contained, allowing cross-compiles, etc. etc.
18 */
19
20struct rtc_time {
21 int tm_sec;
22 int tm_min;
23 int tm_hour;
24 int tm_mday;
25 int tm_mon;
26 int tm_year;
27 int tm_wday;
28 int tm_yday;
29 int tm_isdst;
30};
31
32/*
33 * This data structure is inspired by the EFI (v0.92) wakeup
34 * alarm API.
35 */
36struct rtc_wkalrm {
Andrew Victor304228e2006-06-30 01:56:01 -070037 unsigned char enabled; /* 0 = alarm disabled, 1 = alarm enabled */
38 unsigned char pending; /* 0 = alarm not pending, 1 = alarm pending */
Linus Torvalds1da177e2005-04-16 15:20:36 -070039 struct rtc_time time; /* time the alarm is set to */
40};
41
42/*
43 * Data structure to control PLL correction some better RTC feature
44 * pll_value is used to get or set current value of correction,
45 * the rest of the struct is used to query HW capabilities.
46 * This is modeled after the RTC used in Q40/Q60 computers but
47 * should be sufficiently flexible for other devices
48 *
49 * +ve pll_value means clock will run faster by
50 * pll_value*pll_posmult/pll_clock
51 * -ve pll_value means clock will run slower by
52 * pll_value*pll_negmult/pll_clock
David Brownellab6a2d72007-05-08 00:33:30 -070053 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070054
55struct rtc_pll_info {
56 int pll_ctrl; /* placeholder for fancier control */
57 int pll_value; /* get/set correction value */
58 int pll_max; /* max +ve (faster) adjustment value */
59 int pll_min; /* max -ve (slower) adjustment value */
60 int pll_posmult; /* factor for +ve correction */
61 int pll_negmult; /* factor for -ve correction */
62 long pll_clock; /* base PLL frequency */
63};
64
65/*
66 * ioctl calls that are permitted to the /dev/rtc interface, if
67 * any of the RTC drivers are enabled.
68 */
69
70#define RTC_AIE_ON _IO('p', 0x01) /* Alarm int. enable on */
71#define RTC_AIE_OFF _IO('p', 0x02) /* ... off */
72#define RTC_UIE_ON _IO('p', 0x03) /* Update int. enable on */
73#define RTC_UIE_OFF _IO('p', 0x04) /* ... off */
74#define RTC_PIE_ON _IO('p', 0x05) /* Periodic int. enable on */
75#define RTC_PIE_OFF _IO('p', 0x06) /* ... off */
76#define RTC_WIE_ON _IO('p', 0x0f) /* Watchdog int. enable on */
77#define RTC_WIE_OFF _IO('p', 0x10) /* ... off */
78
79#define RTC_ALM_SET _IOW('p', 0x07, struct rtc_time) /* Set alarm time */
80#define RTC_ALM_READ _IOR('p', 0x08, struct rtc_time) /* Read alarm time */
81#define RTC_RD_TIME _IOR('p', 0x09, struct rtc_time) /* Read RTC time */
82#define RTC_SET_TIME _IOW('p', 0x0a, struct rtc_time) /* Set RTC time */
83#define RTC_IRQP_READ _IOR('p', 0x0b, unsigned long) /* Read IRQ rate */
84#define RTC_IRQP_SET _IOW('p', 0x0c, unsigned long) /* Set IRQ rate */
85#define RTC_EPOCH_READ _IOR('p', 0x0d, unsigned long) /* Read epoch */
86#define RTC_EPOCH_SET _IOW('p', 0x0e, unsigned long) /* Set epoch */
87
88#define RTC_WKALM_SET _IOW('p', 0x0f, struct rtc_wkalrm)/* Set wakeup alarm*/
89#define RTC_WKALM_RD _IOR('p', 0x10, struct rtc_wkalrm)/* Get wakeup alarm*/
90
91#define RTC_PLL_GET _IOR('p', 0x11, struct rtc_pll_info) /* Get PLL correction */
92#define RTC_PLL_SET _IOW('p', 0x12, struct rtc_pll_info) /* Set PLL correction */
93
Alessandro Zummo0c86edc2006-03-27 01:16:37 -080094/* interrupt flags */
Wolfram Sang9796cc92011-05-26 16:25:12 -070095#define RTC_IRQF 0x80 /* Any of the following is active */
96#define RTC_PF 0x40 /* Periodic interrupt */
97#define RTC_AF 0x20 /* Alarm interrupt */
98#define RTC_UF 0x10 /* Update interrupt for 1Hz RTC */
Alessandro Zummo0c86edc2006-03-27 01:16:37 -080099
Thomas Gleixner6e7a3332011-07-22 09:12:51 +0000100
101#define RTC_MAX_FREQ 8192
102
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103#ifdef __KERNEL__
104
Andrew Morton78d89ef2009-03-31 15:24:48 -0700105#include <linux/types.h>
Joe Korty4024ce52006-03-22 00:07:43 -0800106#include <linux/interrupt.h>
107
Alessandro Zummoc58411e2006-03-27 01:16:34 -0800108extern int rtc_month_days(unsigned int month, unsigned int year);
Andrew Victor82322122006-06-25 05:48:25 -0700109extern int rtc_year_days(unsigned int day, unsigned int month, unsigned int year);
Alessandro Zummoc58411e2006-03-27 01:16:34 -0800110extern int rtc_valid_tm(struct rtc_time *tm);
111extern int rtc_tm_to_time(struct rtc_time *tm, unsigned long *time);
112extern void rtc_time_to_tm(unsigned long time, struct rtc_time *tm);
John Stultz6610e082010-09-23 15:07:34 -0700113ktime_t rtc_tm_to_ktime(struct rtc_time tm);
114struct rtc_time rtc_ktime_to_tm(ktime_t kt);
115
Alessandro Zummoc58411e2006-03-27 01:16:34 -0800116
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800117#include <linux/device.h>
118#include <linux/seq_file.h>
119#include <linux/cdev.h>
120#include <linux/poll.h>
121#include <linux/mutex.h>
John Stultz6610e082010-09-23 15:07:34 -0700122#include <linux/timerqueue.h>
123#include <linux/workqueue.h>
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800124
125extern struct class *rtc_class;
126
David Brownell5ad31a572008-07-23 21:30:33 -0700127/*
128 * For these RTC methods the device parameter is the physical device
129 * on whatever bus holds the hardware (I2C, Platform, SPI, etc), which
130 * was passed to rtc_device_register(). Its driver_data normally holds
131 * device state, including the rtc_device pointer for the RTC.
132 *
133 * Most of these methods are called with rtc_device.ops_lock held,
134 * through the rtc_*(struct rtc_device *, ...) calls.
135 *
136 * The (current) exceptions are mostly filesystem hooks:
137 * - the proc() hook for procfs
138 * - non-ioctl() chardev hooks: open(), release(), read_callback()
David Brownell5ad31a572008-07-23 21:30:33 -0700139 *
140 * REVISIT those periodic irq calls *do* have ops_lock when they're
141 * issued through ioctl() ...
142 */
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800143struct rtc_class_ops {
144 int (*open)(struct device *);
145 void (*release)(struct device *);
146 int (*ioctl)(struct device *, unsigned int, unsigned long);
147 int (*read_time)(struct device *, struct rtc_time *);
148 int (*set_time)(struct device *, struct rtc_time *);
149 int (*read_alarm)(struct device *, struct rtc_wkalrm *);
150 int (*set_alarm)(struct device *, struct rtc_wkalrm *);
151 int (*proc)(struct device *, struct seq_file *);
152 int (*set_mmss)(struct device *, unsigned long secs);
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800153 int (*read_callback)(struct device *, int data);
Alessandro Zummo099e6572009-01-04 12:00:54 -0800154 int (*alarm_irq_enable)(struct device *, unsigned int enabled);
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800155};
156
157#define RTC_DEVICE_NAME_SIZE 20
John Stultz6610e082010-09-23 15:07:34 -0700158typedef struct rtc_task {
159 void (*func)(void *private_data);
160 void *private_data;
161} rtc_task_t;
162
163
164struct rtc_timer {
165 struct rtc_task task;
166 struct timerqueue_node node;
167 ktime_t period;
168 int enabled;
169};
170
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800171
Jiri Kosina8853c202007-11-28 16:22:03 -0800172/* flags */
173#define RTC_DEV_BUSY 0
174
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800175struct rtc_device
176{
David Brownellcd966202007-05-08 00:33:40 -0700177 struct device dev;
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800178 struct module *owner;
179
180 int id;
181 char name[RTC_DEVICE_NAME_SIZE];
182
David Brownellff8371a2006-09-30 23:28:17 -0700183 const struct rtc_class_ops *ops;
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800184 struct mutex ops_lock;
185
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800186 struct cdev char_dev;
Jiri Kosina8853c202007-11-28 16:22:03 -0800187 unsigned long flags;
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800188
189 unsigned long irq_data;
190 spinlock_t irq_lock;
191 wait_queue_head_t irq_queue;
192 struct fasync_struct *async_queue;
193
194 struct rtc_task *irq_task;
195 spinlock_t irq_task_lock;
196 int irq_freq;
Alessandro Zummo110d6932006-06-25 05:48:20 -0700197 int max_user_freq;
John Stultz6610e082010-09-23 15:07:34 -0700198
199 struct timerqueue_head timerqueue;
200 struct rtc_timer aie_timer;
201 struct rtc_timer uie_rtctimer;
202 struct hrtimer pie_timer; /* sub second exp, so needs hrtimer */
203 int pie_enabled;
204 struct work_struct irqwork;
John Stultz4a649902012-03-06 17:16:09 -0800205 /* Some hardware can't support UIE mode */
206 int uie_unsupported;
John Stultz6e57b1d2011-02-11 17:45:40 -0800207
208#ifdef CONFIG_RTC_INTF_DEV_UIE_EMUL
209 struct work_struct uie_task;
210 struct timer_list uie_timer;
211 /* Those fields are protected by rtc->irq_lock */
212 unsigned int oldsecs;
213 unsigned int uie_irq_active:1;
214 unsigned int stop_uie_polling:1;
215 unsigned int uie_task_active:1;
216 unsigned int uie_timer_active:1;
217#endif
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800218};
David Brownellcd966202007-05-08 00:33:40 -0700219#define to_rtc_device(d) container_of(d, struct rtc_device, dev)
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800220
221extern struct rtc_device *rtc_device_register(const char *name,
222 struct device *dev,
David Brownellff8371a2006-09-30 23:28:17 -0700223 const struct rtc_class_ops *ops,
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800224 struct module *owner);
David Brownellab6a2d72007-05-08 00:33:30 -0700225extern void rtc_device_unregister(struct rtc_device *rtc);
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800226
David Brownellab6a2d72007-05-08 00:33:30 -0700227extern int rtc_read_time(struct rtc_device *rtc, struct rtc_time *tm);
228extern int rtc_set_time(struct rtc_device *rtc, struct rtc_time *tm);
229extern int rtc_set_mmss(struct rtc_device *rtc, unsigned long secs);
John Stultzf44f7f92011-02-21 22:58:51 -0800230int __rtc_read_alarm(struct rtc_device *rtc, struct rtc_wkalrm *alarm);
David Brownellab6a2d72007-05-08 00:33:30 -0700231extern int rtc_read_alarm(struct rtc_device *rtc,
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800232 struct rtc_wkalrm *alrm);
David Brownellab6a2d72007-05-08 00:33:30 -0700233extern int rtc_set_alarm(struct rtc_device *rtc,
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800234 struct rtc_wkalrm *alrm);
John Stultzf6d5b332011-03-29 18:00:27 -0700235extern int rtc_initialize_alarm(struct rtc_device *rtc,
236 struct rtc_wkalrm *alrm);
David Brownellab6a2d72007-05-08 00:33:30 -0700237extern void rtc_update_irq(struct rtc_device *rtc,
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800238 unsigned long num, unsigned long events);
239
David Brownellab6a2d72007-05-08 00:33:30 -0700240extern struct rtc_device *rtc_class_open(char *name);
241extern void rtc_class_close(struct rtc_device *rtc);
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800242
David Brownellab6a2d72007-05-08 00:33:30 -0700243extern int rtc_irq_register(struct rtc_device *rtc,
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800244 struct rtc_task *task);
David Brownellab6a2d72007-05-08 00:33:30 -0700245extern void rtc_irq_unregister(struct rtc_device *rtc,
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800246 struct rtc_task *task);
David Brownellab6a2d72007-05-08 00:33:30 -0700247extern int rtc_irq_set_state(struct rtc_device *rtc,
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800248 struct rtc_task *task, int enabled);
David Brownellab6a2d72007-05-08 00:33:30 -0700249extern int rtc_irq_set_freq(struct rtc_device *rtc,
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800250 struct rtc_task *task, int freq);
Alessandro Zummo099e6572009-01-04 12:00:54 -0800251extern int rtc_update_irq_enable(struct rtc_device *rtc, unsigned int enabled);
252extern int rtc_alarm_irq_enable(struct rtc_device *rtc, unsigned int enabled);
John Stultz6e57b1d2011-02-11 17:45:40 -0800253extern int rtc_dev_update_irq_enable_emul(struct rtc_device *rtc,
254 unsigned int enabled);
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800255
John Stultz456d66e2011-02-11 18:15:23 -0800256void rtc_handle_legacy_irq(struct rtc_device *rtc, int num, int mode);
John Stultz6610e082010-09-23 15:07:34 -0700257void rtc_aie_update_irq(void *private);
258void rtc_uie_update_irq(void *private);
259enum hrtimer_restart rtc_pie_update_irq(struct hrtimer *timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260
261int rtc_register(rtc_task_t *task);
262int rtc_unregister(rtc_task_t *task);
263int rtc_control(rtc_task_t *t, unsigned int cmd, unsigned long arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264
Thomas Gleixner96c8f062010-12-13 22:45:48 +0100265void rtc_timer_init(struct rtc_timer *timer, void (*f)(void* p), void* data);
266int rtc_timer_start(struct rtc_device *rtc, struct rtc_timer* timer,
John Stultz6610e082010-09-23 15:07:34 -0700267 ktime_t expires, ktime_t period);
Thomas Gleixner96c8f062010-12-13 22:45:48 +0100268int rtc_timer_cancel(struct rtc_device *rtc, struct rtc_timer* timer);
269void rtc_timer_do_work(struct work_struct *work);
John Stultz6610e082010-09-23 15:07:34 -0700270
Andrew Morton78d89ef2009-03-31 15:24:48 -0700271static inline bool is_leap_year(unsigned int year)
272{
273 return (!(year % 4) && (year % 100)) || !(year % 400);
274}
275
Uwe Kleine-Königd0ab4a42010-03-10 15:20:35 -0800276#ifdef CONFIG_RTC_HCTOSYS
277extern int rtc_hctosys_ret;
278#else
279#define rtc_hctosys_ret -ENODEV
280#endif
281
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282#endif /* __KERNEL__ */
283
284#endif /* _LINUX_RTC_H_ */