From patchwork Fri May 25 10:40:53 2012 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: [8/8] lib: fwts_wakealarm.c: add more comments Date: Fri, 25 May 2012 00:40:53 -0000 From: Colin King X-Patchwork-Id: 161284 Message-Id: <1337942453-30224-9-git-send-email-colin.king@canonical.com> To: fwts-devel@lists.ubuntu.com From: Colin Ian King Signed-off-by: Colin Ian King Acked-by: Keng-Yu Lin Acked-by: Ivan Hu --- src/lib/src/fwts_wakealarm.c | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/src/lib/src/fwts_wakealarm.c b/src/lib/src/fwts_wakealarm.c index f830717..56d4317 100644 --- a/src/lib/src/fwts_wakealarm.c +++ b/src/lib/src/fwts_wakealarm.c @@ -27,6 +27,11 @@ static char *fwts_wkalarm = "/sys/class/rtc/rtc0/wakealarm"; +/* + * fwts_wakealarm_get_irq_state() + * get wakealarm IRQ state. checks if alarm_IRQ exists and if + * it is set. + */ int fwts_wakealarm_get_irq_state(void) { FILE *fp; @@ -47,6 +52,10 @@ int fwts_wakealarm_get_irq_state(void) return FWTS_ERROR; } +/* + * fwts_wakealarm_trigger() + * trigger the RTC wakealarm to fire in 'seconds' seconds from now. + */ int fwts_wakealarm_trigger(fwts_framework *fw, const int seconds) { char buffer[32]; @@ -72,6 +81,11 @@ int fwts_wakealarm_trigger(fwts_framework *fw, const int seconds) return FWTS_OK; } +/* + * fwts_wakealarm_test_firing() + * test RTC wakealarm trigger and firing from 'seconds' seconds time + * from now. returns FWTS_OK if passed, otherwise FWTS_ERROR. + */ int fwts_wakealarm_test_firing(fwts_framework *fw, const int seconds) { int ret;