]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - include/linux/alarmtimer.h
rhashtable: Mark internal/private inline functions as such
[mirror_ubuntu-bionic-kernel.git] / include / linux / alarmtimer.h
CommitLineData
ff3ead96
JS
1#ifndef _LINUX_ALARMTIMER_H
2#define _LINUX_ALARMTIMER_H
3
4#include <linux/time.h>
5#include <linux/hrtimer.h>
6#include <linux/timerqueue.h>
7#include <linux/rtc.h>
8
9enum alarmtimer_type {
10 ALARM_REALTIME,
11 ALARM_BOOTTIME,
12
13 ALARM_NUMTYPE,
14};
15
4b41308d
JS
16enum alarmtimer_restart {
17 ALARMTIMER_NORESTART,
18 ALARMTIMER_RESTART,
19};
20
a28cde81
JS
21
22#define ALARMTIMER_STATE_INACTIVE 0x00
23#define ALARMTIMER_STATE_ENQUEUED 0x01
a28cde81 24
180bf812
JS
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.
34 */
ff3ead96
JS
35struct alarm {
36 struct timerqueue_node node;
dae373be 37 struct hrtimer timer;
4b41308d 38 enum alarmtimer_restart (*function)(struct alarm *, ktime_t now);
ff3ead96 39 enum alarmtimer_type type;
a28cde81 40 int state;
ff3ead96
JS
41 void *data;
42};
43
44void alarm_init(struct alarm *alarm, enum alarmtimer_type type,
4b41308d 45 enum alarmtimer_restart (*function)(struct alarm *, ktime_t));
dae373be 46int alarm_start(struct alarm *alarm, ktime_t start);
6cffe00f
TP
47int alarm_start_relative(struct alarm *alarm, ktime_t start);
48void alarm_restart(struct alarm *alarm);
9082c465
JS
49int alarm_try_to_cancel(struct alarm *alarm);
50int alarm_cancel(struct alarm *alarm);
ff3ead96 51
dce75a8c 52u64 alarm_forward(struct alarm *alarm, ktime_t now, ktime_t interval);
6cffe00f
TP
53u64 alarm_forward_now(struct alarm *alarm, ktime_t interval);
54ktime_t alarm_expires_remaining(const struct alarm *alarm);
dce75a8c 55
57c498fa
JS
56/* Provide way to access the rtc device being used by alarmtimers */
57struct rtc_device *alarmtimer_get_rtcdev(void);
58
ff3ead96 59#endif