LXR linux/include/linux/alarmtimer.h

   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
  16enum alarmtimer_restart {
  17        ALARMTIMER_NORESTART,
  18        ALARMTIMER_RESTART,
  19};
  20
  21
  22#define ALARMTIMER_STATE_INACTIVE       0x00
  23#define ALARMTIMER_STATE_ENQUEUED       0x01
  24
  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 */
  35struct 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;
  42};
  43
  44void alarm_init(struct alarm *alarm, enum alarmtimer_type type,
  45                enum alarmtimer_restart (*function)(struct alarm *, ktime_t));
  46int alarm_start(struct alarm *alarm, ktime_t start);
  47int alarm_try_to_cancel(struct alarm *alarm);
  48int alarm_cancel(struct alarm *alarm);
  49
  50u64 alarm_forward(struct alarm *alarm, ktime_t now, ktime_t interval);
  51
  52/* Provide way to access the rtc device being used by alarmtimers */
  53struct rtc_device *alarmtimer_get_rtcdev(void);
  54
  55#endif
  56