1 /* 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. 7 * 8 * 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 #include <linux/types.h> 16 #include <linux/interrupt.h> 17 #include <uapi/linux/rtc.h> 18 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); 26 27 /** 28 * Deprecated. Use rtc_time64_to_tm(). 29 */ 30 static 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 */ 38 static 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 } 44 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> 52 53 extern struct class *rtc_class; 54 55 /* 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() 67 * 68 * REVISIT those periodic irq calls *do* have ops_lock when they're 69 * issued through ioctl() ... 70 */ 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); 83 }; 84 85 #define RTC_DEVICE_NAME_SIZE 20 86 typedef struct rtc_task { 87 void (*func)(void *private_data); 88 void *private_data; 89 } rtc_task_t; 90 91 92 struct rtc_timer { 93 struct rtc_task task; 94 struct timerqueue_node node; 95 ktime_t period; 96 int enabled; 97 }; 98 99 100 /* flags */ 101 #define RTC_DEV_BUSY 0 102 103 struct rtc_device 104 { 105 struct device dev; 106 struct module *owner; 107 108 int id; 109 char name[RTC_DEVICE_NAME_SIZE]; 110 111 const struct rtc_class_ops *ops; 112 struct mutex ops_lock; 113 114 struct cdev char_dev; 115 unsigned long flags; 116 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; 125 int max_user_freq; 126 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; 133 /* Some hardware can't support UIE mode */ 134 int uie_unsupported; 135 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 146 }; 147 #define to_rtc_device(d) container_of(d, struct rtc_device, dev) 148 149 extern struct rtc_device *rtc_device_register(const char *name, 150 struct device *dev, 151 const struct rtc_class_ops *ops, 152 struct module *owner); 153 extern struct rtc_device *devm_rtc_device_register(struct device *dev, 154 const char *name, 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); 160 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); 174 175 extern struct rtc_device *rtc_class_open(const char *name); 176 extern void rtc_class_close(struct rtc_device *rtc); 177 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); 190 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); 195 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); 199 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); 205 206 static inline bool is_leap_year(unsigned int year) 207 { 208 return (!(year % 4) && (year % 100)) || !(year % 400); 209 } 210 211 #ifdef CONFIG_RTC_HCTOSYS_DEVICE 212 extern int rtc_hctosys_ret; 213 #else 214 #define rtc_hctosys_ret -ENODEV 215 #endif 216 217 #endif /* _LINUX_RTC_H_ */ 218