blob: 9531845c419f8329000b8927a341057bb2a64e6d [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);
22extern int rtc_tm_to_time(struct rtc_time *tm, unsigned long *time);
23extern void rtc_time_to_tm(unsigned long 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
Alessandro Zummoc58411e2006-03-27 01:16:34 -080027
Alessandro Zummo0c86edc2006-03-27 01:16:37 -080028#include <linux/device.h>
29#include <linux/seq_file.h>
30#include <linux/cdev.h>
31#include <linux/poll.h>
32#include <linux/mutex.h>
John Stultz6610e082010-09-23 15:07:34 -070033#include <linux/timerqueue.h>
34#include <linux/workqueue.h>
Alessandro Zummo0c86edc2006-03-27 01:16:37 -080035
36extern struct class *rtc_class;
37
David Brownell5ad31a572008-07-23 21:30:33 -070038/*
39 * For these RTC methods the device parameter is the physical device
40 * on whatever bus holds the hardware (I2C, Platform, SPI, etc), which
41 * was passed to rtc_device_register(). Its driver_data normally holds
42 * device state, including the rtc_device pointer for the RTC.
43 *
44 * Most of these methods are called with rtc_device.ops_lock held,
45 * through the rtc_*(struct rtc_device *, ...) calls.
46 *
47 * The (current) exceptions are mostly filesystem hooks:
48 * - the proc() hook for procfs
49 * - non-ioctl() chardev hooks: open(), release(), read_callback()
David Brownell5ad31a572008-07-23 21:30:33 -070050 *
51 * REVISIT those periodic irq calls *do* have ops_lock when they're
52 * issued through ioctl() ...
53 */
Alessandro Zummo0c86edc2006-03-27 01:16:37 -080054struct rtc_class_ops {
55 int (*open)(struct device *);
56 void (*release)(struct device *);
57 int (*ioctl)(struct device *, unsigned int, unsigned long);
58 int (*read_time)(struct device *, struct rtc_time *);
59 int (*set_time)(struct device *, struct rtc_time *);
60 int (*read_alarm)(struct device *, struct rtc_wkalrm *);
61 int (*set_alarm)(struct device *, struct rtc_wkalrm *);
62 int (*proc)(struct device *, struct seq_file *);
63 int (*set_mmss)(struct device *, unsigned long secs);
Alessandro Zummo0c86edc2006-03-27 01:16:37 -080064 int (*read_callback)(struct device *, int data);
Alessandro Zummo099e6572009-01-04 12:00:54 -080065 int (*alarm_irq_enable)(struct device *, unsigned int enabled);
Alessandro Zummo0c86edc2006-03-27 01:16:37 -080066};
67
68#define RTC_DEVICE_NAME_SIZE 20
John Stultz6610e082010-09-23 15:07:34 -070069typedef struct rtc_task {
70 void (*func)(void *private_data);
71 void *private_data;
72} rtc_task_t;
73
74
75struct rtc_timer {
76 struct rtc_task task;
77 struct timerqueue_node node;
78 ktime_t period;
79 int enabled;
80};
81
Alessandro Zummo0c86edc2006-03-27 01:16:37 -080082
Jiri Kosina8853c202007-11-28 16:22:03 -080083/* flags */
84#define RTC_DEV_BUSY 0
85
Alessandro Zummo0c86edc2006-03-27 01:16:37 -080086struct rtc_device
87{
David Brownellcd966202007-05-08 00:33:40 -070088 struct device dev;
Alessandro Zummo0c86edc2006-03-27 01:16:37 -080089 struct module *owner;
90
91 int id;
92 char name[RTC_DEVICE_NAME_SIZE];
93
David Brownellff8371a2006-09-30 23:28:17 -070094 const struct rtc_class_ops *ops;
Alessandro Zummo0c86edc2006-03-27 01:16:37 -080095 struct mutex ops_lock;
96
Alessandro Zummo0c86edc2006-03-27 01:16:37 -080097 struct cdev char_dev;
Jiri Kosina8853c202007-11-28 16:22:03 -080098 unsigned long flags;
Alessandro Zummo0c86edc2006-03-27 01:16:37 -080099
100 unsigned long irq_data;
101 spinlock_t irq_lock;
102 wait_queue_head_t irq_queue;
103 struct fasync_struct *async_queue;
104
105 struct rtc_task *irq_task;
106 spinlock_t irq_task_lock;
107 int irq_freq;
Alessandro Zummo110d6932006-06-25 05:48:20 -0700108 int max_user_freq;
John Stultz6610e082010-09-23 15:07:34 -0700109
110 struct timerqueue_head timerqueue;
111 struct rtc_timer aie_timer;
112 struct rtc_timer uie_rtctimer;
113 struct hrtimer pie_timer; /* sub second exp, so needs hrtimer */
114 int pie_enabled;
115 struct work_struct irqwork;
John Stultz4a649902012-03-06 17:16:09 -0800116 /* Some hardware can't support UIE mode */
117 int uie_unsupported;
John Stultz6e57b1d2011-02-11 17:45:40 -0800118
119#ifdef CONFIG_RTC_INTF_DEV_UIE_EMUL
120 struct work_struct uie_task;
121 struct timer_list uie_timer;
122 /* Those fields are protected by rtc->irq_lock */
123 unsigned int oldsecs;
124 unsigned int uie_irq_active:1;
125 unsigned int stop_uie_polling:1;
126 unsigned int uie_task_active:1;
127 unsigned int uie_timer_active:1;
128#endif
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800129};
David Brownellcd966202007-05-08 00:33:40 -0700130#define to_rtc_device(d) container_of(d, struct rtc_device, dev)
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800131
132extern struct rtc_device *rtc_device_register(const char *name,
133 struct device *dev,
David Brownellff8371a2006-09-30 23:28:17 -0700134 const struct rtc_class_ops *ops,
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800135 struct module *owner);
David Brownellab6a2d72007-05-08 00:33:30 -0700136extern void rtc_device_unregister(struct rtc_device *rtc);
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800137
David Brownellab6a2d72007-05-08 00:33:30 -0700138extern int rtc_read_time(struct rtc_device *rtc, struct rtc_time *tm);
139extern int rtc_set_time(struct rtc_device *rtc, struct rtc_time *tm);
140extern int rtc_set_mmss(struct rtc_device *rtc, unsigned long secs);
John Stultzf44f7f92011-02-21 22:58:51 -0800141int __rtc_read_alarm(struct rtc_device *rtc, struct rtc_wkalrm *alarm);
David Brownellab6a2d72007-05-08 00:33:30 -0700142extern int rtc_read_alarm(struct rtc_device *rtc,
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800143 struct rtc_wkalrm *alrm);
David Brownellab6a2d72007-05-08 00:33:30 -0700144extern int rtc_set_alarm(struct rtc_device *rtc,
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800145 struct rtc_wkalrm *alrm);
John Stultzf6d5b332011-03-29 18:00:27 -0700146extern int rtc_initialize_alarm(struct rtc_device *rtc,
147 struct rtc_wkalrm *alrm);
David Brownellab6a2d72007-05-08 00:33:30 -0700148extern void rtc_update_irq(struct rtc_device *rtc,
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800149 unsigned long num, unsigned long events);
150
David Brownellab6a2d72007-05-08 00:33:30 -0700151extern struct rtc_device *rtc_class_open(char *name);
152extern void rtc_class_close(struct rtc_device *rtc);
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800153
David Brownellab6a2d72007-05-08 00:33:30 -0700154extern int rtc_irq_register(struct rtc_device *rtc,
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800155 struct rtc_task *task);
David Brownellab6a2d72007-05-08 00:33:30 -0700156extern void rtc_irq_unregister(struct rtc_device *rtc,
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800157 struct rtc_task *task);
David Brownellab6a2d72007-05-08 00:33:30 -0700158extern int rtc_irq_set_state(struct rtc_device *rtc,
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800159 struct rtc_task *task, int enabled);
David Brownellab6a2d72007-05-08 00:33:30 -0700160extern int rtc_irq_set_freq(struct rtc_device *rtc,
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800161 struct rtc_task *task, int freq);
Alessandro Zummo099e6572009-01-04 12:00:54 -0800162extern int rtc_update_irq_enable(struct rtc_device *rtc, unsigned int enabled);
163extern int rtc_alarm_irq_enable(struct rtc_device *rtc, unsigned int enabled);
John Stultz6e57b1d2011-02-11 17:45:40 -0800164extern int rtc_dev_update_irq_enable_emul(struct rtc_device *rtc,
165 unsigned int enabled);
Alessandro Zummo0c86edc2006-03-27 01:16:37 -0800166
John Stultz456d66e2011-02-11 18:15:23 -0800167void rtc_handle_legacy_irq(struct rtc_device *rtc, int num, int mode);
John Stultz6610e082010-09-23 15:07:34 -0700168void rtc_aie_update_irq(void *private);
169void rtc_uie_update_irq(void *private);
170enum hrtimer_restart rtc_pie_update_irq(struct hrtimer *timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171
172int rtc_register(rtc_task_t *task);
173int rtc_unregister(rtc_task_t *task);
174int rtc_control(rtc_task_t *t, unsigned int cmd, unsigned long arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175
Thomas Gleixner96c8f062010-12-13 22:45:48 +0100176void rtc_timer_init(struct rtc_timer *timer, void (*f)(void* p), void* data);
177int rtc_timer_start(struct rtc_device *rtc, struct rtc_timer* timer,
John Stultz6610e082010-09-23 15:07:34 -0700178 ktime_t expires, ktime_t period);
Thomas Gleixner96c8f062010-12-13 22:45:48 +0100179int rtc_timer_cancel(struct rtc_device *rtc, struct rtc_timer* timer);
180void rtc_timer_do_work(struct work_struct *work);
John Stultz6610e082010-09-23 15:07:34 -0700181
Andrew Morton78d89ef2009-03-31 15:24:48 -0700182static inline bool is_leap_year(unsigned int year)
183{
184 return (!(year % 4) && (year % 100)) || !(year % 400);
185}
186
David Fries4c24e292012-10-04 17:14:12 -0700187#ifdef CONFIG_RTC_HCTOSYS_DEVICE
Uwe Kleine-Königd0ab4a42010-03-10 15:20:35 -0800188extern int rtc_hctosys_ret;
189#else
190#define rtc_hctosys_ret -ENODEV
191#endif
192
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193#endif /* _LINUX_RTC_H_ */