blob: dcad7ee0d7466c8e7ffd7a050e814db551c95cac [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
pang.xunleic2c11ae2014-11-18 19:15:19 +080027/**
28 * Deprecated. Use rtc_time64_to_tm().
29 */
30static 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 */
38static 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 Zummoc58411e2006-03-27 01:16:34 -080044
Alessandro Zummo0c86edc2006-03-27 01:16:37 -080045#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 Stultz6610e082010-09-23 15:07:34 -070050#include <linux/timerqueue.h>
51#include <linux/workqueue.h>
Alessandro Zummo0c86edc2006-03-27 01:16:37 -080052
53extern struct class *rtc_class;
54
David Brownell5ad31a572008-07-23 21:30:33 -070055/*
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 Brownell5ad31a572008-07-23 21:30:33 -070067 *
68 * REVISIT those periodic irq calls *do* have ops_lock when they're
69 * issued through ioctl() ...
70 */
Alessandro Zummo0c86edc2006-03-27 01:16:37 -080071struct 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);
Alessandro Zummo0c86edc2006-03-27 01:16:37 -080081 int (*read_callback)(struct device *, int data);
Alessandro Zummo099e6572009-01-04 12:00:54 -080082 int (*alarm_irq_enable)(struct device *, unsigned int enabled);
Alessandro Zummo0c86edc2006-03-27 01:16:37 -080083};
84
85#define RTC_DEVICE_NAME_SIZE 20
John Stultz6610e082010-09-23 15:07:34 -070086typedef struct rtc_task {
87 void (*func)(void *private_data);
88 void *private_data;
89} rtc_task_t;
90
91
92struct rtc_timer {
93 struct rtc_task task;
94 struct timerqueue_node node;
95 ktime_t period;
96 int enabled;
97};
98
Alessandro Zummo0c86edc2006-03-27 01:16:37 -080099
Jiri Kosina8853c202007-11-28 16:22:03 -0800100/* flags */
101#define RTC_DEV_BUSY 0
102
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800103struct rtc_device
104{
David Brownellcd966202007-05-08 00:33:40 -0700105 struct device dev;
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800106 struct module *owner;
107
108 int id;
109 char name[RTC_DEVICE_NAME_SIZE];
110
David Brownellff8371a2006-09-30 23:28:17 -0700111 const struct rtc_class_ops *ops;
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800112 struct mutex ops_lock;
113
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800114 struct cdev char_dev;
Jiri Kosina8853c202007-11-28 16:22:03 -0800115 unsigned long flags;
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800116
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 Zummo110d6932006-06-25 05:48:20 -0700125 int max_user_freq;
John Stultz6610e082010-09-23 15:07:34 -0700126
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 Stultz4a649902012-03-06 17:16:09 -0800133 /* Some hardware can't support UIE mode */
134 int uie_unsupported;
John Stultz6e57b1d2011-02-11 17:45:40 -0800135
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 Zummo0c86edc2006-03-27 01:16:37 -0800146};
David Brownellcd966202007-05-08 00:33:40 -0700147#define to_rtc_device(d) container_of(d, struct rtc_device, dev)
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800148
149extern struct rtc_device *rtc_device_register(const char *name,
150 struct device *dev,
David Brownellff8371a2006-09-30 23:28:17 -0700151 const struct rtc_class_ops *ops,
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800152 struct module *owner);
Jingoo Han6636a992013-04-29 16:18:33 -0700153extern struct rtc_device *devm_rtc_device_register(struct device *dev,
154 const char *name,
Jingoo Han3e217b62013-04-29 16:18:27 -0700155 const struct rtc_class_ops *ops,
156 struct module *owner);
David Brownellab6a2d72007-05-08 00:33:30 -0700157extern void rtc_device_unregister(struct rtc_device *rtc);
Jingoo Han3e217b62013-04-29 16:18:27 -0700158extern void devm_rtc_device_unregister(struct device *dev,
159 struct rtc_device *rtc);
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800160
David Brownellab6a2d72007-05-08 00:33:30 -0700161extern int rtc_read_time(struct rtc_device *rtc, struct rtc_time *tm);
162extern int rtc_set_time(struct rtc_device *rtc, struct rtc_time *tm);
163extern int rtc_set_mmss(struct rtc_device *rtc, unsigned long secs);
Xunlei Pang9a4a4452015-01-22 02:31:55 +0000164extern int rtc_set_ntp_time(struct timespec64 now);
John Stultzf44f7f92011-02-21 22:58:51 -0800165int __rtc_read_alarm(struct rtc_device *rtc, struct rtc_wkalrm *alarm);
David Brownellab6a2d72007-05-08 00:33:30 -0700166extern int rtc_read_alarm(struct rtc_device *rtc,
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800167 struct rtc_wkalrm *alrm);
David Brownellab6a2d72007-05-08 00:33:30 -0700168extern int rtc_set_alarm(struct rtc_device *rtc,
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800169 struct rtc_wkalrm *alrm);
John Stultzf6d5b332011-03-29 18:00:27 -0700170extern int rtc_initialize_alarm(struct rtc_device *rtc,
171 struct rtc_wkalrm *alrm);
David Brownellab6a2d72007-05-08 00:33:30 -0700172extern void rtc_update_irq(struct rtc_device *rtc,
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800173 unsigned long num, unsigned long events);
174
Michał Mirosław9f3b7952013-02-01 20:40:17 +0100175extern struct rtc_device *rtc_class_open(const char *name);
David Brownellab6a2d72007-05-08 00:33:30 -0700176extern void rtc_class_close(struct rtc_device *rtc);
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800177
David Brownellab6a2d72007-05-08 00:33:30 -0700178extern int rtc_irq_register(struct rtc_device *rtc,
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800179 struct rtc_task *task);
David Brownellab6a2d72007-05-08 00:33:30 -0700180extern void rtc_irq_unregister(struct rtc_device *rtc,
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800181 struct rtc_task *task);
David Brownellab6a2d72007-05-08 00:33:30 -0700182extern int rtc_irq_set_state(struct rtc_device *rtc,
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800183 struct rtc_task *task, int enabled);
David Brownellab6a2d72007-05-08 00:33:30 -0700184extern int rtc_irq_set_freq(struct rtc_device *rtc,
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800185 struct rtc_task *task, int freq);
Alessandro Zummo099e6572009-01-04 12:00:54 -0800186extern int rtc_update_irq_enable(struct rtc_device *rtc, unsigned int enabled);
187extern int rtc_alarm_irq_enable(struct rtc_device *rtc, unsigned int enabled);
John Stultz6e57b1d2011-02-11 17:45:40 -0800188extern int rtc_dev_update_irq_enable_emul(struct rtc_device *rtc,
189 unsigned int enabled);
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800190
John Stultz456d66e2011-02-11 18:15:23 -0800191void rtc_handle_legacy_irq(struct rtc_device *rtc, int num, int mode);
John Stultz6610e082010-09-23 15:07:34 -0700192void rtc_aie_update_irq(void *private);
193void rtc_uie_update_irq(void *private);
194enum hrtimer_restart rtc_pie_update_irq(struct hrtimer *timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195
196int rtc_register(rtc_task_t *task);
197int rtc_unregister(rtc_task_t *task);
198int rtc_control(rtc_task_t *t, unsigned int cmd, unsigned long arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199
Thomas Gleixner96c8f062010-12-13 22:45:48 +0100200void rtc_timer_init(struct rtc_timer *timer, void (*f)(void* p), void* data);
201int rtc_timer_start(struct rtc_device *rtc, struct rtc_timer* timer,
John Stultz6610e082010-09-23 15:07:34 -0700202 ktime_t expires, ktime_t period);
Thomas Gleixner96c8f062010-12-13 22:45:48 +0100203int rtc_timer_cancel(struct rtc_device *rtc, struct rtc_timer* timer);
204void rtc_timer_do_work(struct work_struct *work);
John Stultz6610e082010-09-23 15:07:34 -0700205
Andrew Morton78d89ef2009-03-31 15:24:48 -0700206static inline bool is_leap_year(unsigned int year)
207{
208 return (!(year % 4) && (year % 100)) || !(year % 400);
209}
210
David Fries4c24e292012-10-04 17:14:12 -0700211#ifdef CONFIG_RTC_HCTOSYS_DEVICE
Uwe Kleine-Königd0ab4a42010-03-10 15:20:35 -0800212extern int rtc_hctosys_ret;
213#else
214#define rtc_hctosys_ret -ENODEV
215#endif
216
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217#endif /* _LINUX_RTC_H_ */