diff options
author | John Stultz <john.stultz@linaro.org> | 2011-04-28 15:58:11 -0400 |
---|---|---|
committer | John Stultz <john.stultz@linaro.org> | 2011-04-28 16:39:17 -0400 |
commit | 180bf812ceaf01eb8ac69b86f3be0bd57f697668 (patch) | |
tree | e61166d1267a15115dc602875ec03835afc1afe7 /include | |
parent | 9a7adcf5c6dea63d2e47e6f6d2f7a6c9f48b9337 (diff) |
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')
-rw-r--r-- | include/linux/alarmtimer.h | 12 |
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 { | |||
13 | ALARM_NUMTYPE, | 13 | ALARM_NUMTYPE, |
14 | }; | 14 | }; |
15 | 15 | ||
16 | /** | ||
17 | * struct alarm - Alarm timer structure | ||
18 | * @node: timerqueue node for adding to the event list this value | ||
19 | * also includes the expiration time. | ||
20 | * @period: Period for recuring alarms | ||
21 | * @function: Function pointer to be executed when the timer fires. | ||
22 | * @type: Alarm type (BOOTTIME/REALTIME) | ||
23 | * @enabled: Flag that represents if the alarm is set to fire or not | ||
24 | * @data: Internal data value. | ||
25 | */ | ||
16 | struct alarm { | 26 | struct alarm { |
17 | struct timerqueue_node node; | 27 | struct timerqueue_node node; |
18 | ktime_t period; | 28 | ktime_t period; |
19 | void (*function)(struct alarm *); | 29 | void (*function)(struct alarm *); |
20 | enum alarmtimer_type type; | 30 | enum alarmtimer_type type; |
21 | char enabled; | 31 | bool enabled; |
22 | void *data; | 32 | void *data; |
23 | }; | 33 | }; |
24 | 34 | ||