summaryrefslogtreecommitdiff
path: root/include/linux/alarmtimer.h
diff options
context:
space:
mode:
authorJohn Stultz <john.stultz@linaro.org>2011-04-28 23:58:11 +0400
committerJohn Stultz <john.stultz@linaro.org>2011-04-29 00:39:17 +0400
commit180bf812ceaf01eb8ac69b86f3be0bd57f697668 (patch)
treee61166d1267a15115dc602875ec03835afc1afe7 /include/linux/alarmtimer.h
parent9a7adcf5c6dea63d2e47e6f6d2f7a6c9f48b9337 (diff)
downloadlinux-180bf812ceaf01eb8ac69b86f3be0bd57f697668.tar.xz
timers: Improve alarmtimer comments and minor fixes
This patch addresses a number of minor comment improvements and other minor issues from Thomas' review of the alarmtimers code. CC: Thomas Gleixner <tglx@linutronix.de> Signed-off-by: John Stultz <john.stultz@linaro.org>
Diffstat (limited to 'include/linux/alarmtimer.h')
-rw-r--r--include/linux/alarmtimer.h12
1 files changed, 11 insertions, 1 deletions
diff --git a/include/linux/alarmtimer.h b/include/linux/alarmtimer.h
index 6b364b2e2074..c5d6095b46f8 100644
--- a/include/linux/alarmtimer.h
+++ b/include/linux/alarmtimer.h
@@ -13,12 +13,22 @@ enum alarmtimer_type {
ALARM_NUMTYPE,
};
+/**
+ * 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.
+ */
struct alarm {
struct timerqueue_node node;
ktime_t period;
void (*function)(struct alarm *);
enum alarmtimer_type type;
- char enabled;
+ bool enabled;
void *data;
};