Linux 3.9-rc4
[linux-2.6/cjktty.git] / include / linux / alarmtimer.h
blob9069694e70eb9eee8b1bf4e229f29f7959ce3b46
1 #ifndef _LINUX_ALARMTIMER_H
2 #define _LINUX_ALARMTIMER_H
4 #include <linux/time.h>
5 #include <linux/hrtimer.h>
6 #include <linux/timerqueue.h>
7 #include <linux/rtc.h>
9 enum alarmtimer_type {
10 ALARM_REALTIME,
11 ALARM_BOOTTIME,
13 ALARM_NUMTYPE,
16 enum alarmtimer_restart {
17 ALARMTIMER_NORESTART,
18 ALARMTIMER_RESTART,
22 #define ALARMTIMER_STATE_INACTIVE 0x00
23 #define ALARMTIMER_STATE_ENQUEUED 0x01
25 /**
26 * struct alarm - Alarm timer structure
27 * @node: timerqueue node for adding to the event list this value
28 * also includes the expiration time.
29 * @period: Period for recuring alarms
30 * @function: Function pointer to be executed when the timer fires.
31 * @type: Alarm type (BOOTTIME/REALTIME)
32 * @enabled: Flag that represents if the alarm is set to fire or not
33 * @data: Internal data value.
35 struct alarm {
36 struct timerqueue_node node;
37 struct hrtimer timer;
38 enum alarmtimer_restart (*function)(struct alarm *, ktime_t now);
39 enum alarmtimer_type type;
40 int state;
41 void *data;
44 void alarm_init(struct alarm *alarm, enum alarmtimer_type type,
45 enum alarmtimer_restart (*function)(struct alarm *, ktime_t));
46 int alarm_start(struct alarm *alarm, ktime_t start);
47 int alarm_try_to_cancel(struct alarm *alarm);
48 int alarm_cancel(struct alarm *alarm);
50 u64 alarm_forward(struct alarm *alarm, ktime_t now, ktime_t interval);
52 /* Provide way to access the rtc device being used by alarmtimers */
53 struct rtc_device *alarmtimer_get_rtcdev(void);
55 #endif