alarmtimer.h 1.1 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
#ifndef _LINUX_ALARMTIMER_H
#define _LINUX_ALARMTIMER_H

#include <linux/time.h>
#include <linux/hrtimer.h>
#include <linux/timerqueue.h>
#include <linux/rtc.h>

enum alarmtimer_type {
	ALARM_REALTIME,
	ALARM_BOOTTIME,

	ALARM_NUMTYPE,
};

16 17 18 19 20
enum alarmtimer_restart {
	ALARMTIMER_NORESTART,
	ALARMTIMER_RESTART,
};

21 22 23 24 25 26 27 28 29 30
/**
 * struct alarm - Alarm timer structure
 * @node:	timerqueue node for adding to the event list this value
 *		also includes the expiration time.
 * @period:	Period for recuring alarms
 * @function:	Function pointer to be executed when the timer fires.
 * @type:	Alarm type (BOOTTIME/REALTIME)
 * @enabled:	Flag that represents if the alarm is set to fire or not
 * @data:	Internal data value.
 */
31 32 33
struct alarm {
	struct timerqueue_node	node;
	ktime_t			period;
34
	enum alarmtimer_restart	(*function)(struct alarm *, ktime_t now);
35
	enum alarmtimer_type	type;
36
	bool			enabled;
37 38 39 40
	void			*data;
};

void alarm_init(struct alarm *alarm, enum alarmtimer_type type,
41
		enum alarmtimer_restart (*function)(struct alarm *, ktime_t));
42 43 44 45
void alarm_start(struct alarm *alarm, ktime_t start, ktime_t period);
void alarm_cancel(struct alarm *alarm);

#endif