[PATCH] RTC subsystem: class
[linux-3.10.git] / include / linux / rtc.h
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  * The struct used to pass data via the following ioctl. Similar to the
16  * struct tm in <time.h>, but it needs to be here so that the kernel 
17  * source is self contained, allowing cross-compiles, etc. etc.
18  */
19
20 struct 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  */
36 struct rtc_wkalrm {
37         unsigned char enabled;  /* 0 = alarm disable, 1 = alarm disabled */
38         unsigned char pending;  /* 0 = alarm pending, 1 = alarm not pending */
39         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
53  */ 
54
55 struct 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
94 /* interrupt flags */
95 #define RTC_IRQF 0x80 /* any of the following is active */
96 #define RTC_PF 0x40
97 #define RTC_AF 0x20
98 #define RTC_UF 0x10
99
100 #ifdef __KERNEL__
101
102 #include <linux/interrupt.h>
103
104 extern int rtc_month_days(unsigned int month, unsigned int year);
105 extern int rtc_valid_tm(struct rtc_time *tm);
106 extern int rtc_tm_to_time(struct rtc_time *tm, unsigned long *time);
107 extern void rtc_time_to_tm(unsigned long time, struct rtc_time *tm);
108
109 #include <linux/device.h>
110 #include <linux/seq_file.h>
111 #include <linux/cdev.h>
112 #include <linux/poll.h>
113 #include <linux/mutex.h>
114
115 extern struct class *rtc_class;
116
117 struct rtc_class_ops {
118         int (*open)(struct device *);
119         void (*release)(struct device *);
120         int (*ioctl)(struct device *, unsigned int, unsigned long);
121         int (*read_time)(struct device *, struct rtc_time *);
122         int (*set_time)(struct device *, struct rtc_time *);
123         int (*read_alarm)(struct device *, struct rtc_wkalrm *);
124         int (*set_alarm)(struct device *, struct rtc_wkalrm *);
125         int (*proc)(struct device *, struct seq_file *);
126         int (*set_mmss)(struct device *, unsigned long secs);
127         int (*irq_set_state)(struct device *, int enabled);
128         int (*irq_set_freq)(struct device *, int freq);
129         int (*read_callback)(struct device *, int data);
130 };
131
132 #define RTC_DEVICE_NAME_SIZE 20
133 struct rtc_task;
134
135 struct rtc_device
136 {
137         struct class_device class_dev;
138         struct module *owner;
139
140         int id;
141         char name[RTC_DEVICE_NAME_SIZE];
142
143         struct rtc_class_ops *ops;
144         struct mutex ops_lock;
145
146         struct class_device *rtc_dev;
147         struct cdev char_dev;
148         struct mutex char_lock;
149
150         unsigned long irq_data;
151         spinlock_t irq_lock;
152         wait_queue_head_t irq_queue;
153         struct fasync_struct *async_queue;
154
155         struct rtc_task *irq_task;
156         spinlock_t irq_task_lock;
157         int irq_freq;
158 };
159 #define to_rtc_device(d) container_of(d, struct rtc_device, class_dev)
160
161 extern struct rtc_device *rtc_device_register(const char *name,
162                                         struct device *dev,
163                                         struct rtc_class_ops *ops,
164                                         struct module *owner);
165 extern void rtc_device_unregister(struct rtc_device *rdev);
166 extern int rtc_interface_register(struct class_interface *intf);
167
168 extern int rtc_read_time(struct class_device *class_dev, struct rtc_time *tm);
169 extern int rtc_set_time(struct class_device *class_dev, struct rtc_time *tm);
170 extern int rtc_set_mmss(struct class_device *class_dev, unsigned long secs);
171 extern int rtc_read_alarm(struct class_device *class_dev,
172                         struct rtc_wkalrm *alrm);
173 extern int rtc_set_alarm(struct class_device *class_dev,
174                                 struct rtc_wkalrm *alrm);
175 extern void rtc_update_irq(struct class_device *class_dev,
176                         unsigned long num, unsigned long events);
177
178 extern struct class_device *rtc_class_open(char *name);
179 extern void rtc_class_close(struct class_device *class_dev);
180
181 extern int rtc_irq_register(struct class_device *class_dev,
182                                 struct rtc_task *task);
183 extern void rtc_irq_unregister(struct class_device *class_dev,
184                                 struct rtc_task *task);
185 extern int rtc_irq_set_state(struct class_device *class_dev,
186                                 struct rtc_task *task, int enabled);
187 extern int rtc_irq_set_freq(struct class_device *class_dev,
188                                 struct rtc_task *task, int freq);
189
190 typedef struct rtc_task {
191         void (*func)(void *private_data);
192         void *private_data;
193 } rtc_task_t;
194
195 int rtc_register(rtc_task_t *task);
196 int rtc_unregister(rtc_task_t *task);
197 int rtc_control(rtc_task_t *t, unsigned int cmd, unsigned long arg);
198 void rtc_get_rtc_time(struct rtc_time *rtc_tm);
199 irqreturn_t rtc_interrupt(int irq, void *dev_id, struct pt_regs *regs);
200
201 #endif /* __KERNEL__ */
202
203 #endif /* _LINUX_RTC_H_ */